API utilisateur
Utilisez l'API utilisateur pour créer, mettre à jour ou interroger les données utilisateur.
Utilisez les API utilisateur pour créer, mettre à jour ou interroger les données utilisateur.
L'URL pour accéder aux API est : https ://<instance>.cso.coupahost.com/api/users
Voir les meilleures pratiques d'intégration pour plus d'informations.
Actions
| Verbe | Chemin d'accès | Action | Description |
|---|---|---|---|
| OBTENIR | /API/utilisateurs |
index | Effectue une action Get pour récupérer tous les utilisateurs |
| PUBLIER | /api/users |
créer | Crée un ou plusieurs utilisateurs. |
| METTRE | /api/users |
mettre à jour | Met à jour un ou plusieurs utilisateurs . Peut effectuer des mises à jour de masse. |
| OBTENIR | /api/users/:id |
afficher | Affiche les données utilisateur. |
| METTRE | /api/users/:id |
mettre à jour | Mettre à jour un utilisateur à la fois à l'aide de l'ID |
Éléments
Ce sont les éléments disponibles pour l'API Utilisateur
| Nom de champ | Description du champ | Req'd | Unique ? | Valeurs admissibles | Dans | Sortie * | Type |
|---|---|---|---|---|---|---|---|
| iD |
ID de l'utilisateur |
Oui | oui | nombre entier | |||
| état | Statut de l'utilisateur |
Bloqué, actif, désactivé, supprimé (sensible à la casse) |
oui | oui | chaîne | ||
| nom | Le nom de connexion de l'utilisateur. Une fois défini, ne peut pas être modifié. | Oui | oui | chaîne | |||
| prénom | Le prénom de l'utilisateur | oui | |||||
| nom | Le nom de famille de l'utilisateur | oui | |||||
| numéro de téléphone | Numéro de téléphone de l'utilisateur | oui | oui | chaîne | |||
| numéro de portable | Le numéro de téléphone portable de l'utilisateur | oui | |||||
| Adresse courriel de l'utilisateur. Une fois défini, il ne peut pas être modifié. | oui | chaîne | |||||
| company-id | L'ID de l'entreprise pour l'utilisateur. Une fois défini, il ne peut pas être modifié | ||||||
| rue | Partie rue de l'adresse de l'utilisateur | oui | oui | chaîne | |||
| code postal | Code postal faisant partie de l'adresse de l'utilisateur | oui | oui | chaîne | |||
| ville | Partie de la ville de l'adresse de l'utilisateur | oui | oui | chaîne | |||
| pays | Partie du pays de l'adresse de l'utilisateur | oui | oui | chaîne | |||
| mots-clés | Mots-clés associés à l'utilisateur | oui | oui | chaîne | |||
| nom-utilisateur-externe | Le nom d'utilisateur externe attribué à l'utilisateur. | oui | |||||
| accept-agreement | Indique si l'utilisateur a accepté ou non les accords requis. | oui | oui | ||||
| fournir-informations | Indique si oui ou non l'utilisateur doit fournir des informations sur l'utilisateur lors de la prochaine connexion. | oui | oui | ||||
| change-password | Indique si l'utilisateur doit ou non changer de mot de passe à sa prochaine connexion. | oui | |||||
| invoicing_user | Facturation de l'utilisateur | any | oui | boolean |
La charge utile de réponse n'affiche pas de valeurs NULL.
Exemples
Dans cet exemple, nous avons demandé une API utilisateur. Nous avons accédé À l'URL :
https ://<instance>.cso.coupahost.com/api/users
Réponse de l'utilisateur GET
{
"total" : 3,
"users" : [
{
"id" : "9219595862193003588",
"state" : "Actif",
"nom" : "dekke434",
"prénom" : "Arjan",
"last-name" : "Goud",
"numéro de téléphone" : "+310987898789",
"numéro-mobile" : "+31(0) 6 98876554",
"email" : "a.goud@deeder.com",
"company-id" : "9219592232917474305",
"rue" : "IJsseldijk ouest 66",
"code postal" : "2935AR",
"ville" : "Ouderkerk aan den IJssel",
"pays" : "Pays-Bas",
"accept-agreement" : false,
"provide-information" : false,
"change-password" : false
},
{
"id" : "9219595145795283441",
"state" : "Actif",
"name" : "acte",
"prénom" : "Arjan",
"last-name" : "Deeed",
"numéro de téléphone" : "+313132323133",
"email" : "mh@test.nl",
"company-id" : "9219592331212583950",
"pays" : "Pays-Bas",
"accept-agreement" : false,
"provide-information" : true,
"change-password" : true
},
{
"id" : "9219592232917474526",
"state" : "Actif",
"nom" : "eurot494",
"prénom" : "Marjus",
"last-name" : "van Dee",
"numéro de téléphone" : "+31121212121",
"numéro-de-mobile" : "+31313131333",
"email" : "test@test.com",
"company-id" : "9219592232917474528",
"rue" : "Brielselaan 69, Havre 1357",
"code postal" : "3081AA",
"ville" : "Rotterdam",
"pays" : "Pays-Bas",
"accept-agreement" : false,
"provide-information" : true,
"change-password" : false
}
]
}Créer/Actualiser
Ce qui suit décrit comment vous pouvez utiliser l'API Coupa pour effectuer des actions sur l'utilisateur.
Créer
/api/users
La charge utile ci-dessous crée deux utilisateurs.
Charge utile :
{
"users" : [
{
"state" : "Actif",
"nom" : "testeur123456",
"first-name" : "testeur",
"last-name" : "utilisateur1",
"numéro de téléphone" : "+1(111)-234-5678",
"numéro-de-mobile" : "+1(11)-123-3456",
"email" : "testeruser@tester.com",
"company-id" : "9220538753250662192",
"rue" : "12345 bethoven road",
"code postal" : "30811",
"ville" : "Rotterdam",
"pays" : "États-Unis",
"accept-agreement" : false,
"provide-information" : true,
"change-password" : false
},
{
"nom" : "testeur12345",
"first-name" : "test",
"last-name" : "utilisateur",
"numéro de téléphone" : "+1(111)-234-5678",
"numéro-de-mobile" : "+1(11)-123-3456",
"email" : "tester@tester.com",
"company-id" : "9220538753250662192",
"rue" : "12345 bethoven road",
"code postal" : "30811",
"ville" : "Rotterdam",
"pays" : "États-Unis",
"accept-agreement" : true,
"provide-information" : true,
"change-password" : false
}
]
}
Réponse : 201
{
"result" : [
{
"type" : "api.post.added",
"description" : "2 objets créés."
}
],
"ajouté" : 2,
"users" : [
{
"id" : "9220538753483272432"
},
{
"id" : "9220538753482068122"
}
]
} Mettre à jour
/API/utilisateurs
La charge utile ci-dessous met à jour un (des) utilisateur(s).
Pour mettre à jour un ou plusieurs utilisateurs à la fois :
Charge utile :
{
"users" : [
{
"id" : "9220538753483272432",
"state" : "Bloqué",
"email" : "testeruser-upd@tester.com",
"accept-agreement" : true,
"provide-information" : true,
"change-password" : false
},
{
"id" : "9220538753482068122",
"state" : "Bloqué",
"email" : "tester-upd@tester.com",
"accept-agreement" : false,
"provide-information" : true,
"change-password" : false
}
]
}
Réponse : 200 OK
{
"result" : [
{
"type" : "api.put.updated",
"description" : "2 objets mis à jour."
}
],
"mis à jour" : 2
}Les mises à jour sont effectuées de manière indulgente, c'est-à-dire que si la mise à jour d'une ressource échoue, les autres pourraient réussir. L'ID utilisateur est requis pour les mises à jour.
Les demandes réussies renverront une réponse HTTP 200. Le corps de la réponse inclura la demande créée. Les demandes infructueuses renverront HTTP 400 Bad Request. Le corps de la réponse comprendra des erreurs de validation formatées en XML.