Compartir a través de

API de plataforma digital: proceso de autenticación

  • Artículo

Para poder realizar llamadas a cualquiera de los servicios o informes de Digital Platform API, debe usar el nombre de usuario y la contraseña para obtener un token de autorización. El token permanece activo durante 2 horas, durante las cuales no es necesario volver a autenticarse. Además, hay una expiración dura de 24 horas. Cuando una sesión de API alcanza la marca de 24 horas, independientemente de cuándo se haya realizado la llamada API más reciente, esa sesión expirará.

Esta página le guiará por el proceso de autenticación.

Nota:

  • Para obtener una explicación de los errores que puede encontrar durante y después de la autenticación, consulte Mensajes de error.
  • Si su nombre de usuario y contraseña no le conceden acceso a la API, consulte el proceso de incorporación de la API o póngase en contacto con su representante de Xandr.
  • Si ha olvidado su nombre de usuario o contraseña, puede usar account recovery service para recuperar el nombre de usuario o crear una nueva contraseña.

Paso 1. Creación de un archivo JSON, incluidos el nombre de usuario y la contraseña

A continuación, hemos usado el cat comando para mostrar la salida del archivo.

$ cat auth
{
    "auth": {
        "username" : "USERNAME",
        "password" : "PASSWORD"
    }
}

Directrices para crear la contraseña

Al crear la contraseña, cree una contraseña compleja con lo siguiente:

  • 10 o más caracteres
  • 64 caracteres o menos
  • Al menos una letra mayúscula (A–Z)
  • Al menos una letra minúscula (a–z)
  • Al menos un dígito (0–9)
  • Al menos un carácter especial (como #, $, ? %, &)

Paso 2. POST el archivo al servicio de autenticación

La solicitud devuelve un token que permanece válido durante las 2 horas siguientes a la llamada más reciente a la API. Se recomienda usar "-b cookies -c cookies" en la POST solicitud para almacenar el token en una cookie.

$ curl -b cookies -c cookies -X POST -d @auth 'https://api.appnexus.com/auth'
{
    "response": {
        "status": "OK",
        "token": "h20hbtptiv3vlp1rkm3ve1qig0",
        "dbg_info": {
            ...
        }
    }
}

Paso 3. Uso del token al realizar llamadas a informes y servicios de API

En el ejemplo siguiente, llamamos al servicio miembro y nos autenticamos mediante el token almacenado en la cookie.

$ curl -b cookies -c cookies 'https://api.appnexus.com/member'
{
    "response": {
        "members": [
            {
                "id": "1",
                "name": "Car company c\/o Ad Agency",
                "active": "1",
                "bidder_id": "2"
            }
        ]
    }
}

Como alternativa, si no ha almacenado el token en una cookie, puede colocar el token en el encabezado de solicitud como "Authorization: TOKEN".

$ curl -H "Authorization: 622cee5f8c99c81e87614e9efc63eddb" 'https://api.appnexus.com/member'
{
    "response": {
        "members": [
            {
                "id": "1",
                "name": "Member 1",
                "active": "1",
                "bidder_id": "2"
            }
        ]
    }
}

Nota:

Para mayor seguridad, también es posible autenticarse mediante tokens web JSON. Consulte Autenticación de API basada en tokens para obtener más información.

Frecuencia de autenticación

Después de autenticarse, el token permanece válido durante 2 horas. No es necesario volver a autenticarse en este momento. Si vuelve a autenticarse, tenga en cuenta la siguiente limitación: La API le permite autenticarse correctamente 10 veces por período de 5 minutos. Los intentos de autenticación posteriores en esos 5 minutos producirán un error.

Sugerencia

Se recomienda escuchar en las "NOAUTH"error_id respuestas de llamada y volver a autenticarse solo después de recibirlo.