Servicio de datos

Información general

La API de datos de Yield Analytics expone la funcionalidad para buscar datos y configuraciones disponibles desde el entorno de Yield Analytics.

Tipos de contenido

La API de REST de servicio está diseñada actualmente para admitir el siguiente tipo de contenido:

  • JSON - using Content-type: application/json

Seleccionar el tipo de contenido deseado es una elección que el desarrollador de API debe hacer caso por caso. La funcionalidad de la API es simétrica entre los tipos de contenido. Los desarrolladores de API pueden especificar el tipo de contenido deseado en los parámetros del método HTTP GET o POST o a través de su biblioteca de cliente AJAX o HTTP.

Comprobación de errores y códigos de estado

Los desarrolladores de API deben comprobar los códigos de respuesta HTTP devueltos desde la API REST de servicio para detectar errores propagados a partir de llamadas API. Las llamadas correctas al servicio darán como resultado códigos de respuesta de 200 intervalos. Las respuestas HTTP de rango 400 y 500 denotan errores. Es probable que los códigos de respuesta y el texto específicos experimenten cambios durante el desarrollo BETA de la API, sin embargo, los rangos no lo harán.

Seguridad

La API de servicio expone los datos de la aplicación de forma segura. El uso de la funcionalidad de la API está restringido a los usuarios autenticados y se expone a través de protocolos de transporte seguros. El acceso a la API debe realizarse en el siguiente contexto:

Autenticación

Para obtener más información sobre la autenticación, consulte API de Yield Analytics - Proceso de autenticación

Confidencialidad

La confidencialidad se mantiene mediante el uso de la comunicación basada en Secure Socket Layer para interactuar con la API de Yield Analytics. Los desarrolladores de API deben preferir el uso de HTTPS sobre una comunicación insegura de HTTP siempre que sea posible. Consulte la biblioteca de clientes HTTP para saber cómo habilitar HTTP sobre SSL al desarrollar fuera del contexto de un explorador web.

Host

https://api.appnexus.com/imf/

Paths

Obtener columnas de alias

GET /api/v1/rest/data/aliasColumns

  • Descripción

    Obtener solicitud para leer una colección de columnas de alias.

  • Parámetros

    Tipo Nombre Descripción Obligatorio Esquema
    HeaderParameter usuario Su nombre de usuario para acceder a la API de Yield Analytics true string
    HeaderParameter contraseña Su contraseña para acceder a la API de Yield Analytics true string

  • Respuestas

    Código HTTP Descripción Esquema
    200 Aceptar Columnas de alias

  • Consume

    application/json

  • Produce

    • application/XML
    • application/json

  • Tags

    Recurso de datos

  • Ejemplo de solicitud de cURL

    $ curl 'https://api.appnexus.com/imf/v1/rest/data/aliasColumns' -i -H 'Content-Type: application/json' -H 'Accept: application/json' -H 
'username: {{username}}' -H 'password: {{password}}'

  • Ejemplo de solicitud HTTP

    GET /api/v1/rest/data/aliasColumns HTTP/1.1
Content-Type: application/json
Accept: application/json
username: {{username}}
password: {{password}}
Host: https://api.appnexus.com/imf/

  • Ejemplo de respuesta HTTP

    HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 187

{
  "aliasColumns" : [ {
    "aliasKey" : "TARGET_OVERLAPPING_PRODUCT",
    "dateSourceType" : "TARGET"
  }, {
    "aliasKey" : "BOOKED_VALUE",
    "dateSourceType" : "ORDER_LINE"
  } ]
}

Obtener funciones de alias

GET /api/v1/rest/data/aliasFunctions

  • Descripción

    Get para leer una colección de funciones de alias.

  • Parámetros

    Tipo Nombre Descripción Obligatorio Esquema
    HeaderParameter usuario Su nombre de usuario para acceder a la API de Yield Analytics true string
    HeaderParameter contraseña Su contraseña para acceder a la API de Yield Analytics true string

  • Respuestas

    Código HTTP Descripción Esquema
    200 Aceptar Funciones de alias

  • Consume

    application/json

  • Produce

    • application/XML
    • application/json

  • Tags

    Recurso de datos

  • Ejemplo de solicitud de cURL

    $ curl 'https://api.appnexus.com/imf/v1/rest/data/aliasColumns' -i -H 'Content-Type: application/json' -H 'Accept: application/json' -H 
'username: {{username}}' -H 'password: {{password}}'

  • Ejemplo de solicitud HTTP

    GET /api/v1/rest/data/aliasColumns HTTP/1.1
Content-Type: application/json
Accept: application/json
username: {{username}}
password: {{password}}
Host: https://api.appnexus.com/imf/

  • Ejemplo de respuesta HTTP

    HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 187

{
  "aliasColumns" : [ {
    "aliasKey" : "TARGET_OVERLAPPING_PRODUCT",
    "dateSourceType" : "TARGET"
  }, {
    "aliasKey" : "BOOKED_VALUE",
    "dateSourceType" : "ORDER_LINE"
  } ]
}

Obtener filtros de consumo

GET /api/v1/rest/data/consumptionFilters

  • Descripción

    Obtener solicitud para leer una colección de filtros de consumo.

  • Parámetros

    Tipo Nombre Descripción Obligatorio Esquema
    HeaderParameter usuario Su nombre de usuario para acceder a la API de Yield Analytics true string
    HeaderParameter contraseña Su contraseña para acceder a la API de Yield Analytics true string

  • Respuestas

    Código HTTP Descripción Esquema
    200 Aceptar ConsumptionFilters

  • Consume

    application/json

  • Produce

    • application/XML
    • application/json

  • Tags

    Recurso de datos

  • Ejemplo de solicitud de cURL

    $ curl 'https://api.appnexus.com/imf/v1/rest/data/consumptionFilters' -i -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'username: {{username}}' -H 'password: {{password}}'
'Accept: application/json' -H 'username: {{username}}' -H 'password: {{password}}'

  • Ejemplo de solicitud HTTP

    GET /api/v1/rest/data/consumptionFilters HTTP/1.1
Content-Type: application/json
Accept: application/json
username: {{username}}
password: {{password}}
Host: https://api.appnexus.com/imf/

  • Ejemplo de respuesta HTTP

    HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 82

{
  "consumptionFilters" : [ "CONSUMPTION_TYPE", "INVENTORY_CLASS", "PRIORITY" ]
}

Definiciones

AliasColumn

Un objeto JSON para contener la solicitud de AliasColumn.

Nombre Obligatorio Esquema
aliasKey false string
dateSourceType false string

Columnas de alias

Un objeto JSON para contener la solicitud de AliasColumns.

Nombre Obligatorio Esquema
aliasColumns false Matriz AliasColumn

Función de alias

Un objeto JSON para contener la solicitud de AliasFunction.

Nombre Obligatorio Esquema
entradas false matriz de cadena
name false string

Funciones de alias

Un objeto JSON para contener la solicitud de AliasFunctions.

Nombre Obligatorio Esquema
aliasFunctions false Matriz AliasFunction

ConsumptionFilters

Un objeto JSON para contener la solicitud de ConsumptionFilters.

Nombre Obligatorio Esquema
consumptionFilters false matriz de cadena
  • Last updated on