API de Yield Analytics - Proceso de autenticación

Esta página le guía por el proceso de autenticación:

  • La autenticación es necesaria antes de acceder a cualquier servicio de API. Las API de IMF exponen los datos de las aplicaciones de forma segura y solo están disponibles para los usuarios autenticados a través de protocolos de transporte seguros.
  • Antes de llamar a cualquier punto final de la API de IMF, debe autenticarse utilizando el nombre de usuario y la contraseña de su plataforma a través del servicio de autenticación en: https://api.appnexus.com/auth.
  • Una solicitud de autenticación correcta devuelve un token de autorización válido durante dos horas. A continuación, este token se puede usar para realizar solicitudes a todos los puntos de conexión en: https://api.appnexus.com/imf.
  • No es necesaria una nueva autenticación mientras el token siga siendo válido.
  • Para mayor comodidad, se recomienda almacenar el token de autorización en una cookie mediante las opciones de la solicitud de -b cookies -c cookies autenticación. Esto garantiza que el token se incluya automáticamente en todas las llamadas API posteriores.

Nota:

El nombre de usuario y la contraseña de autenticación son las mismas credenciales que se usan para la API de plataforma digital o Microsoft Monetize.

Sugerencia

Si ha olvidado su nombre de usuario o contraseña, puede utilizar el Servicio de recuperación de cuenta para recuperar su nombre de usuario o crear una nueva contraseña.

Paso 1. Crear un archivo con formato JSON, incluido el nombre de usuario y la contraseña

A continuación, hemos utilizado 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 caracteres o más
  • 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 2 horas. Se recomienda usarlo "-b cookies -c cookies" en la solicitud POST 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": "h3vlp0122344",
        "dbg_info": {
            ...
        }
    }
}

Paso 3. Uso del token al realizar llamadas a los servicios de API de IMF

El token emitido se puede usar para acceder a todos los puntos de conexión disponibles en el punto de conexión api.appnexus.com/imfdel host.

$ curl -b cookies -c cookies 'https://api.appnexus.com/imf/api/v1/rest/data/aliasFunctions'
{
    "response": {
        "aliasFunctions": [
            {
                "name": "ACTIVE_CUSTOM_PRODUCTS",
                "inputs": [
                "ARRAY"
                ]
            },
        ...
        ]
    }
}

Como alternativa, si no almacenó el token en una cookie, puede poner el token en el encabezado de solicitud como "Authorization: TOKEN".

$ curl -H "Authorization: h3vlp0122344" 'https://api.appnexus.com/imf/api/v1/rest/data/aliasFunctions' 
{
    "response": {
        "aliasFunctions": [
            {
                "name": "ACTIVE_CUSTOM_PRODUCTS",
                "inputs": [
                "ARRAY"
                ]
            },
        ...
        ]
    }
}

Frecuencia de autenticación

Tras la autenticación, el token seguirá siendo válido durante 2 horas. No es necesario que vuelva a autenticarse dentro de este tiempo. Si no te vuelves a autenticar, ten en cuenta la siguiente limitación:

  • La API le permite autenticarse correctamente 10 veces por un período de 5 minutos.
  • Cualquier intento de autenticación posterior dentro de esos 5 minutos producirá un error.

Sugerencia

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

  • Last updated on