Partager via

Service de données

Vue d’ensemble

L’API de données Yield Analytics expose des fonctionnalités pour la recherche de données et de configurations disponibles à partir de l’environnement Yield Analytics.

Types de contenu

L’API REST de service est actuellement conçue pour prendre en charge le type de contenu suivant :

  • JSON - utilisation de Content-type: application/json

La sélection du type de contenu souhaité est un choix que le développeur d’API doit faire au cas par cas. La fonctionnalité d’API est symétrique entre les types de contenu. Les développeurs d’API peuvent spécifier le type de contenu souhaité dans les paramètres de la méthode HTTP GET ou POST ou via leur bibliothèque de client AJAX ou HTTP.

Vérification des erreurs et codes status

Les développeurs d’API doivent case activée les codes de réponse HTTP retournés par l’API REST du service pour détecter les erreurs propagées à partir des appels d’API. Les appels réussis au service entraînent l’utilisation de 200 codes de réponse de plage. Les réponses HTTP de plage 400 et 500 indiquent des erreurs. Les codes de réponse et le texte spécifiques seront probablement modifiés pendant le développement BÊTA de l’API, mais pas les plages.

Sécurité

L’API de service expose les données d’application de manière sécurisée. L’utilisation des fonctionnalités d’API est limitée aux utilisateurs authentifiés et est exposée via des protocoles de transport sécurisés. L’accès à l’API doit avoir lieu dans le contexte suivant :

  • Exemple d’authentification cURL

    L’authentification se produit en transmettant des informations d’identification via des en-têtes HTTP sur chaque requête.

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

  • Exemple d’authentification HTTPS

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

  • Exemple d’authentification POSTMAN

    Recherchez un exemple de paramètres d’en-tête dans Postman ci-dessous :

    Remarque

    • 'Authorization' est défini sur « No Auth » ; Les paramètres ci-dessous doivent être placés sous l’onglet « En-têtes ».
    • Pour obtenir un didacticiel plus approfondi sur l’utilisation de Postman, consultez Utilisation de Postman avec l’API Yield Analytics.

    Capture d’écran de l’onglet En-têtes avec des clés et des valeurs standard dans Postman.

Confidentialité

La confidentialité est maintenue à l’aide de la communication basée sur la couche de sockets sécurisés pour interagir avec l’API Yield Analytics. Les développeurs d’API doivent préférer l’utilisation du protocole HTTPS à la communication http non sécurisée dans la mesure du possible. Consultez votre bibliothèque cliente HTTP pour savoir comment activer HTTP sur SSL lors du développement en dehors d’un contexte de navigateur web.

Paths

Obtenir des colonnes d’alias

GET /api/v1/rest/data/aliasColumns

  • Description

    Obtenir une demande de lecture d’une collection de colonnes d’alias.

  • Paramètres

    Type Nom Description Obligatoire Schéma
    HeaderParameter username Votre nom d’utilisateur pour accéder à l’API Yield Analytics true chaîne
    HeaderParameter mot de passe Votre mot de passe pour accéder à l’API Yield Analytics true chaîne
    HeaderParameter source Votre source cliente pour accéder à l’API Yield Analytics true string

  • Réponses

    HTTP Code Description Schéma
    200 OK AliasColumns

  • Consomme

    application/json

  • Produit

    • application/xml
    • application/json

  • Tags

    Ressource de données

  • Exemple de demande cURL

    $ 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}}'

  • Exemple de requête HTTP

    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

  • Exemple de réponse 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"
  } ]
}

Obtenir des fonctions d’alias

GET /api/v1/rest/data/aliasFunctions

  • Description

    Obtenir une demande de lecture d’une collection de fonctions d’alias.

  • Paramètres

    Type Nom Description Obligatoire Schéma
    HeaderParameter username Votre nom d’utilisateur pour accéder à l’API Yield Analytics true chaîne
    HeaderParameter mot de passe Votre mot de passe pour accéder à l’API Yield Analytics true string
    HeaderParameter source Votre source cliente pour accéder à l’API Yield Analytics true string

  • Réponses

    HTTP Code Description Schéma
    200 OK AliasFunctions

  • Consomme

    application/json

  • Produit

    • application/xml
    • application/json

  • Tags

    Ressource de données

  • Exemple de demande cURL

    $ 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}}'

  • Exemple de requête HTTP

    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

  • Exemple de réponse 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"
  } ]
}

Obtenir des filtres de consommation

GET /api/v1/rest/data/consumptionFilters

  • Description

    Obtenir une demande de lecture d’une collection de filtres de consommation.

  • Paramètres

    Type Nom Description Obligatoire Schéma
    HeaderParameter username Votre nom d’utilisateur pour accéder à l’API Yield Analytics true string
    HeaderParameter mot de passe Votre mot de passe pour accéder à l’API Yield Analytics true string
    HeaderParameter source Votre source cliente pour accéder à l’API Yield Analytics true string

  • Réponses

    HTTP Code Description Schéma
    200 OK ConsumptionFilters

  • Consomme

    application/json

  • Produit

    • application/xml
    • application/json

  • Tags

    Ressource de données

  • Exemple de demande cURL

    $ 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}}'

  • Exemple de requête HTTP

    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

  • Exemple de réponse HTTP

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

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

Définitions

AliasColumn

Objet JSON pour contenir la demande d’AliasColumn.

Nom Obligatoire Schéma
aliasKey false chaîne
dateSourceType false chaîne

AliasColumns

Objet JSON pour contenir la requête pour AliasColumns.

Nom Obligatoire Schéma
aliasColumns false Tableau AliasColumn

AliasFunction

Objet JSON pour contenir la demande d’AliasFunction.

Nom Obligatoire Schéma
Entrées false tableau de chaînes
nom false chaîne

AliasFunctions

Objet JSON pour contenir la requête pour AliasFunctions.

Nom Obligatoire Schéma
aliasFunctions false Tableau AliasFunction

ConsumptionFilters

Objet JSON pour contenir la requête pour ConsumptionFilters.

Nom Obligatoire Schéma
consumptionFilters false tableau de chaînes

Yield Analytics API

  • Last updated on