Compartir a través de

Servicio de datos

  • Artículo

Información general

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

Tipos de contenido

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

  • JSON: mediante Content-type: application/json

Seleccionar el tipo de contenido deseado es una opción que el desarrollador de la API debe tomar caso por caso. La funcionalidad de 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 cliente AJAX o HTTP.

Códigos de estado y comprobación de errores

Los desarrolladores de API deben comprobar los códigos de respuesta HTTP devueltos desde la API REST del servicio para detectar los errores propagados por las llamadas API. Las llamadas correctas al servicio generarán 200 códigos de respuesta de intervalo. Las respuestas HTTP de intervalo 400 y 500 denotan errores. Es probable que los códigos de respuesta y el texto específicos cambien durante el desarrollo beta de la API; sin embargo, los intervalos no.

Seguridad

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

  • Ejemplo de autenticación cURL

    La autenticación se produce pasando credenciales a través de encabezados HTTP en cada solicitud.

    - username: curl -H "username:username"
- password: curl -H "password:password"
- source: curl -H "source:client_id"

  • Autenticación HTTPS de ejemplo

    GET /api/v1/rest/
HTTPS/1.1
Host: yieldanalytics.xandr.com
Accept: application/xml, application/json
Content-Type: application/json
username: {{username}}
password: {{password}}
source: {{client_id}}

  • Ejemplo de autenticación POSTMAN

    Busque un ejemplo de configuración de encabezado en Postman a continuación:

    Nota:

    • "Autorización" se establece en "Sin autenticación"; la configuración siguiente se colocará en la pestaña "Encabezados".
    • Para obtener un tutorial más detallado sobre el uso de Postman, consulte Uso de Postman con yield analytics API.

    Captura de pantalla de la pestaña Encabezados con claves y valores estándar en Postman.

Confidencialidad

La confidencialidad se mantiene mediante la comunicación basada en capa de socket seguro para interactuar con yield analytics API. Los desarrolladores de API deben preferir el uso de HTTPS en lugar de una comunicación HTTP insegura siempre que sea posible. Consulte la biblioteca cliente HTTP sobre cómo habilitar HTTP a través de SSL al desarrollar fuera de un contexto de explorador web.

Paths

Obtener columnas de alias

GET /api/v1/rest/data/aliasColumns

  • Descripción

    Obtenga la solicitud para leer una colección de columnas de alias.

  • Parámetros

    Tipo Nombre Descripción Obligatorio Esquema
    HeaderParameter usuario Nombre de usuario para acceder a Yield Analytics API true string
    HeaderParameter contraseña La contraseña para acceder a yield analytics API true string
    HeaderParameter source El origen de cliente para acceder a yield analytics API true string

  • Respuestas

    Código HTTP Description Esquema
    200 Aceptar AliasColumns

  • Consume

    application/json

  • Produce

    • application/xml
    • application/json

  • Tags

    Recurso de datos

  • Solicitud cURL de ejemplo

    $ curl 'https://{{client_url}}/api/v1/rest/v1/rest/data/aliasColumns' -i -H 'Content-Type: application/json' -H 'Accept: application/json' -H 
'username: {{username}}' -H 'password: {{password}}' -H 'source: {{source}}'

  • Solicitud HTTP de ejemplo

    GET /api/v1/rest/data/aliasColumns HTTP/1.1
Content-Type: application/json
Accept: application/json
username: {{username}}
password: {{password}}
source: {{source}}
Host: https://{{client_url}}/api/v1/rest

  • Respuesta HTTP de ejemplo

    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

    Obtenga una solicitud para leer una colección de funciones de alias.

  • Parámetros

    Tipo Nombre Descripción Obligatorio Esquema
    HeaderParameter usuario Nombre de usuario para acceder a Yield Analytics API true string
    HeaderParameter contraseña La contraseña para acceder a yield analytics API true string
    HeaderParameter source El origen de cliente para acceder a yield analytics API true string

  • Respuestas

    Código HTTP Description Esquema
    200 Aceptar AliasFunctions

  • Consume

    application/json

  • Produce

    • application/xml
    • application/json

  • Tags

    Recurso de datos

  • Solicitud cURL de ejemplo

    $ curl 'https://{{client_url}}/api/v1/rest/v1/rest/data/aliasColumns' -i -H 'Content-Type: application/json' -H 'Accept: application/json' -H 
'username: {{username}}' -H 'password: {{password}}' -H 'source: {{source}}'

  • Solicitud HTTP de ejemplo

    GET /api/v1/rest/data/aliasColumns HTTP/1.1
Content-Type: application/json
Accept: application/json
username: {{username}}
password: {{password}}
source: {{source}}
Host: https://{{client_url}}/api/v1/rest

  • Respuesta HTTP de ejemplo

    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"
  } ]
}

Obtención de filtros de consumo

GET /api/v1/rest/data/consumptionFilters

  • Descripción

    Obtenga la solicitud para leer una colección de filtros de consumo.

  • Parámetros

    Tipo Nombre Descripción Obligatorio Esquema
    HeaderParameter usuario Nombre de usuario para acceder a Yield Analytics API true string
    HeaderParameter contraseña La contraseña para acceder a yield analytics API true string
    HeaderParameter source El origen de cliente para acceder a yield analytics API true string

  • Respuestas

    Código HTTP Description Esquema
    200 Aceptar ConsumptionFilters

  • Consume

    application/json

  • Produce

    • application/xml
    • application/json

  • Tags

    Recurso de datos

  • Solicitud cURL de ejemplo

    $ curl 'https://{{client_url}}/api/v1/rest/v1/rest/data/consumptionFilters' -i -H 'Content-Type: application/json' -H 
'Accept: application/json' -H 'username: {{username}}' -H 'password: {{password}}' -H 'source: {{source}}'

  • Solicitud HTTP de ejemplo

    GET /api/v1/rest/data/consumptionFilters HTTP/1.1
Content-Type: application/json
Accept: application/json
username: {{username}}
password: {{password}}
source: {{source}}
Host: https://{{client_url}}/api/v1/rest

  • Respuesta HTTP de ejemplo

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

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

Definiciones

AliasColumn

Objeto JSON que contiene la solicitud de AliasColumn.

Nombre Obligatorio Esquema
aliasKey false string
dateSourceType false string

AliasColumns

Objeto JSON que contiene la solicitud de AliasColumns.

Nombre Obligatorio Esquema
aliasColumns false Matriz AliasColumn

AliasFunction

Objeto JSON que contiene la solicitud de AliasFunction.

Nombre Obligatorio Esquema
Entradas false matriz de cadena
name false string

AliasFunctions

Objeto JSON que contiene la solicitud de AliasFunctions.

Nombre Obligatorio Esquema
aliasFunctions false Matriz AliasFunction

ConsumptionFilters

Objeto JSON que contiene la solicitud de ConsumptionFilters.

Nombre Obligatorio Esquema
consumptionFilters false matriz de cadena

Yield Analytics API