Soumissionnaires - Service d’authentification

Avant d’utiliser l’API, vous devez utiliser votre nom d’utilisateur et votre mot de passe pour obtenir un jeton d’autorisation. Pour obtenir le jeton, effectuez une POST demande à https://api.adnxs.com/auth avec un fichier JSON contenant vos informations d’identification d’authentification.

Cette opération retourne une réponse JSON avec le jeton . Vous avez ensuite deux options :

• placez le jeton dans l’en-tête dans les demandes ultérieures en tant qu’autorisation : TOKEN ou
• placez-la dans un cookie à l’aide de la méthode décrite ci-dessous (recommandée).

Si vous n’avez pas de nom d’utilisateur et de mot de passe, contactez votre représentant Xandr.

Période

Lorsque vous vous authentifiez, vous recevez un jeton d’autorisation qui reste actif pendant 2 heures après votre appel le plus récent. Il est recommandé de vous authentifier à nouveau uniquement une fois que vous avez reçu le "NOAUTH"``error_id dans vos réponses d’appel. Si vous suivez cette pratique, la restriction ci-dessus ne doit avoir aucun impact sur votre implémentation.

En outre, le service ajoute une expiration définitive de 24 heures. Lorsqu’une session d’API atteint la marque de 24 heures, cette session expire, quel que soit le moment où l’appel d’API le plus récent a été effectué. Le comportement actuel, dans lequel une session expire après deux heures d’inactivité de la part du client, reste inchangé. Les programmes qui suivent les instructions des meilleures pratiques d’API ne doivent pas être affectés.

Exemple

Create un fichier texte au format JSON avec votre nom d’utilisateur et votre mot de passe. Ci-dessous, nous avons utilisé la cat commande pour afficher la sortie d’un exemple de fichier.

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

Effectuez ensuite une requête POST à l’aide du "auth" fichier . La demande d’autorisation définit un cookie de session (IBAPI_SESSID) et retourne un jeton au format JSON. Notez que nous avons utilisé le paramètre « verbose » dans l’exemple ci-dessous.

curl -v -X POST --data-binary @auth https://api.adnxs.com/auth
< HTTP/1.1 200 OK
< Date: Fri, 22 Aug 2008 12:12:13 GMT
< Set-Cookie: IBAPI_SESSID=622cee5f8c99c81e87614e9efc63eddb; path=/
< Content-Length: 58
< Content-Type: text/html
<
{
    "response": {
        "token": "622cee5f8c99c81e87614e9efc63eddb"
    }
}

Ce jeton peut maintenant être utilisé pour effectuer une requête à partir de l’API :

$ curl -H "Authorization: 622cee5f8c99c81e87614e9efc63eddb" https://api.adnxs.com/member
{
    "response": {
        "members": [
            {
                "id": "1",
                "name": "Car company c\/o Ad Agency",
                "active": "1",
                "bidder_id": "2"
            }
        ]
    }
}

Nous pouvons également utiliser le cookie. Il s’agit de la méthode recommandée et de la notation que nous utilisons dans nos exemples. Voici un exemple utilisant le service membre.

$ curl -b cookies -c cookies -X POST -d @auth "https://api.adnxs.com/auth"
{
    "response": {
        "token": "622cee5f8c99c81e87614e9efc63eddb"
    }
}
$ curl -b cookies https://api.adnxs.com/member
{
    "response": {
        "members": [
            {
                "id": "1",
                "name": "Car company c\/o Ad Agency",
                "active": "1",
                "bidder_id": "2"
            }
        ]
    }
}

Vous pouvez vous authentifier 10 fois dans un délai de 5 minutes. Toutes les tentatives d’authentification suivantes dans ces 5 minutes entraînent une erreur.