Remarque
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de modifier des répertoires.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de modifier des répertoires.
Ici, « utilisateur » fait référence à des personnes ou des groupes utilisant les API de Xandr. Le service utilisateur vous permet de gérer qui a accès aux API de Xandr. Les utilisateurs sont classés comme étant de type d’utilisateur offrant ou membre.
- Les utilisateurs soumissionnaires peuvent être créés par d’autres utilisateurs soumissionnaires.
- Un soumissionnaire-utilisateur peut créer et mettre à jour des utilisateurs-membres, ainsi que mettre à jour ses propres informations utilisateur.
- Un membre-utilisateur peut mettre à jour ses propres informations utilisateur.
- Chaque nouveau nom d’utilisateur associé à un soumissionnaire particulier doit être unique.
API REST
| HTTP, méthode | Endpoint | Description |
|---|---|---|
| GET | https://api.adnxs.com/user |
Affichez tous les utilisateurs que vous avez créés. |
| GET | https://api.adnxs.com/user/USER_ID |
Afficher un utilisateur particulier. |
| POST |
https://api.adnxs.com/user (json utilisateur) |
Ajouter un utilisateur. |
| PUT |
https://api.adnxs.com/user/USER_ID (json utilisateur) |
Modifier un utilisateur existant. |
Pour supprimer un utilisateur existant :
SUPPRIMER https://api.adnxs.com/user/USER_ID
Structure JSON
| Champ | Obligatoire | Type | Description |
|---|---|---|---|
| id | oui (lors de la mise à jour) | int | ID interne associé à l’utilisateur. |
| Active | Non | Bool | Actuellement, vous ne pouvez pas supprimer un utilisateur. Pour l’instant, définissez sur actif sur « false » |
| username | oui (lors de l’ajout) | string(50) | Nom de l'utilisateur. Les noms d’utilisateur doivent être uniques. Remarque : Une fois qu’un utilisateur est créé, le nom d’utilisateur ne peut pas être modifié. |
| mot de passe | oui (lors de l’ajout) | chaîne | Mot de passe de l’utilisateur. |
| oui | chaîne | Email de l’utilisateur. (Notez qu’un utilisateur peut être créé sans e-mail, mais cela entraînera des problèmes ultérieurement lors de la tentative de mise à jour de l’utilisateur.) | |
| user_type | oui | enum('soumissionnaire','member') | Type d’utilisateur ajouté. |
| read_only | Non | Valeur booléenne | Les utilisateurs dont read_only champ est défini sur true ne peuvent pas ajouter, modifier ou supprimer des ressources. |
| entity_id | oui (lors de l’ajout) | int | ID de l’entité à laquelle l’utilisateur appartient (membre ou soumissionnaire). Si le user_type est « soumissionnaire », il s’agit de l’ID du soumissionnaire. Si le user_type est « membre », il s’agit de l’ID de membre. |
| entity_name | Non | string | Nom de l’entité à laquelle l’utilisateur appartient (membre ou soumissionnaire). |
| Prenom | Non | string | Prénom de l’utilisateur |
| last_name | Non | string | Nom de famille de l’utilisateur |
| phone | Non | string | Contact téléphonique de l’utilisateur |
| publisher_id | Non | string | Ce champ est utilisé uniquement pour Displaywords |
| advertiser_id | Non | string | Ce champ est utilisé uniquement pour Displaywords |
| advertiser_access | Non | tableau d’objets | Le ou les annonceurs auxquels l’utilisateur peut accéder, si user_type est "member_advertiser". |
| publisher_access | Non | tableau d’objets | Le ou les éditeurs auxquels l’utilisateur peut accéder, si user_type est "member_publisher". |
| api_login | Non | Valeur booléenne | True si l’utilisateur a accès à l’API. La valeur par défaut est False. Il s’agit d’un champ administrateur uniquement. Si vous créez un utilisateur qui a besoin d’un accès à l’API, contactez le support technique pour demander que cette valeur soit définie sur True. |
| custom_data | Non | string | Toute information pertinente pour l’utilisateur. |
| send_safety_budget_notifications | Non | Valeur booléenne | Si truela valeur est , l’utilisateur reçoit Notifications par e-mail lorsque le seuil du budget de sécurité quotidien est atteint. Pour plus d’informations, consultez le daily_budget champ sur le service membre. |
| Timezone | Non | string | Fuseau horaire de l’utilisateur. |
| entity_reporting_decimal_type | Non | string | Indique si les valeurs numériques sont séparées par une virgule ou une décimale dans les rapports. Si ce champ est défini sur decimal, la valeur retournée est mise en forme comme suit : 1234.56. Alors que, si ce champ est défini sur comma, la valeur retournée est mise en forme comme suit : 1234.56.Valeurs possibles : - decimal- comma |
| reporting_decimal_type | Non | string | Caractère utilisé pour les décimales dans les rapports. Valeurs possibles : - "comma"- "decimal" (point)Ce paramètre peut être remplacé au niveau du rapport (voir reporting_decimal_type dans le service de rapports). |
| decimal_mark | Non | string | Caractère utilisé pour représenter une marque décimale, telle que « point » pour une valeur de 12,7. |
| thousand_seperator | Non | string | Caractère utilisé pour séparer des milliers de valeurs numériques, telles que « virgule » pour la valeur 1 276. |
| last_modified | Non | date | Date de la dernière modification des paramètres utilisateur. |
| is_developer | Non | Valeur booléenne | En lecture seule. Cet indicateur donne à l’utilisateur des droits d’accès à certains services axés sur les développeurs, tels que les services de plug-in et d’instance de plug-in, qui sont utilisés par les applications. Elle est définie sur true par un administrateur Xandr au cas par cas. |
| role_id | Non | int | ID du rôle associé à cet utilisateur. |
| password_expires_on | Non | date | Date d’expiration du mot de passe de l’utilisateur. |
| password_last_changed_on | Non | date | Date de la dernière modification du mot de passe de l’utilisateur. |
Exemples
Jeton d’authentification
L’authentification est toujours la première étape lors de l’utilisation des services d’API. Le jeton d’authentification peut ensuite être écrit dans notre fichier de cookie pour une utilisation ultérieure. Pour obtenir des instructions plus détaillées, consultez Service d’authentification .
Create un fichier texte de profil utilisateur
Pour accorder à l’API l’accès à « TestUser », vous allez créer un fichier texte au format JSON avec le nom d’utilisateur et le mot de passe de l’utilisateur, ainsi que l’ID d’un membre ou d’un soumissionnaire auquel appartient cet utilisateur. Ci-dessous, nous avons utilisé la commande « cat » pour générer un exemple de fichier JSON utilisateur.
$ cat user
{
"user":{
"username":"TestUser",
"password":"2323test",
"entity_id":7,
"email": "user1@examplecompany.com",
"user_type": "bidder"
}
}
Instructions pour la création de votre mot de passe
Lorsque vous créez votre mot de passe, créez un mot de passe complexe avec les éléments suivants :
- 10 caractères ou plus
- 64 caractères ou moins
- Au moins une lettre majuscule (A–Z)
- Au moins une lettre minuscule (a–z)
- Au moins un chiffre (0-9)
- Au moins un caractère spécial (par exemple, #, $, ? %, &)
Ajouter un nouvel utilisateur au cache Imp Bus
Nous allons maintenant entrer le fichier utilisateur. Nous avons utilisé des cookies pour nous authentifier.
$ curl -b cookies -c cookies -X POST --data-binary @user https://api.adnxs.com/user
{
"response":{
"status":"OK",
"id":59
}
}
Récupérer les informations utilisateur du cache Imp Bus
Grâce à la sortie de la commande ci-dessus, nous savons que l’utilisateur que nous venons d’ajouter s’est vu attribuer l’ID #59 par l’Imp Bus. Nous pouvons utiliser cet ID pour afficher des informations sur cet utilisateur particulier. Pour voir tous les utilisateurs que nous avons créés, nous allons laisser l’ID utilisateur.
$ curl -b cookies -c cookies https://api.adnxs.com/user/59
{
"response": {
"status": "OK",
"count": 1,
"start_element": null,
"num_elements": null,
"user": {
"id": 59,
"active": true,
"first_name": null,
"last_name": null,
"phone": null,
"username": "TestUser",
"email": "user1@examplecompany.com",
"user_type": "bidder",
"read_only": false,
"api_login": false,
"entity_id": 7,
"publisher_id": null,
"advertiser_id": null,
"custom_data": null,
"send_safety_budget_notifications": false,
"entity_name": "Platform Services Test Bidder",
"timezone": null,
"entity_reporting_decimal_type": null,
"reporting_decimal_type": null,
"decimal_mark": "period",
"thousand_separator": "comma",
"last_modified": "2017-02-16 19:06:47",
"is_developer": false,
"role_id": null,
"languages": null,
"advertiser_access": null,
"publisher_access": null
},
"dbg": {
...
}
}
}
Demander l’accès à l’API
Notez dans le code retourné au-dessus du champ api_login . Ce champ ne peut être modifié que par un administrateur Xandr. La dernière étape pour accorder à un utilisateur l’accès à l’API consiste à contacter le support client et à demander que l’indicateur api_login pour l’utilisateur soit défini sur true. Veillez à inclure un nom d’utilisateur ou un ID dans la demande.