• Dernière modification le: 25 March 2021

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

Consultez la rubrique Bonnes pratiques d'intégration pour plus d'informations.

Actions

Verbe Chemin d'accès Action Description
OBTENIR /api/users index Exécute une action Obtenir pour récupérer tous les utilisateurs
POSTE /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 en masse.
OBTENIR /api/users/:id montrer Affiche les données utilisateur. 
METTRE /api/users/:id mettre à jour Mettre à jour un utilisateur à la fois en utilisant l'ID

Éléments

Il s'agit des éléments disponibles pour l'API utilisateur

Nom de champ Description du champ Demande d'achat Unique ? Valeurs autorisées Dans Sortie * Type
id

ID de l'utilisateur

  Oui     oui entier
déclarer Statut de l'utilisateur    

Bloqué, Actif, Désactivé, Supprimé (sensible à la casse)

oui oui chaîne
Nom 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 de famille 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-mobile Numéro de téléphone portable de l'utilisateur       oui    
courrier électronique Adresse électronique de l'utilisateur. Une fois défini, il ne peut pas être modifié.         oui chaîne
id-société ID de la société 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 Partie du code postal de l'adresse utilisateur       oui oui chaîne
ville Ville de l'adresse de l'utilisateur       oui oui chaîne
pays Partie du pays de l'adresse utilisateur       oui oui chaîne
mots-clés Mots clés associés à l'utilisateur       oui oui chaîne
nom-utilisateur-externe Nom d'utilisateur externe attribué à l'utilisateur.         oui  
accepte le contrat Indique si l'utilisateur a accepté ou non les accords requis.       oui oui  
informations_fournisseur Indique si l'utilisateur doit ou non fournir des informations à la prochaine connexion.       oui oui  
changer le mot de passe Indique si l'utilisateur doit modifier son mot de passe à la prochaine connexion.       oui    
Remarque

 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 GET utilisateur

{
		"total": 3,
		"users": [
				{
						"id": "9219595862193003588",
						"state": "Active",
						"name": "dekke434",
						"first-name": "Arjan",
						"last-name": "Goud",
						"phone-number": "+310987898789",
						"mobile-number": "+31(0) 6 98876554",
						"email": "a.goud@deeder.com",
						"company-id": "9219592232917474305",
						"street": "IJsseldijk west 66",
						"zip-code": "2935AR",
						"city": "Ouderkerk aan den IJssel",
						"country": "Netherlands",
						"accepts-agreement": false,
						"provide-information": false,
						"change-password": false
				},
				{
						"id": "9219595145795283441",
						"state": "Active",
						"name": "deeed",
						"first-name": "Arjan",
						"last-name": "Deeed",
						"phone-number": "+313132323133",
						"email": "mh@test.nl",
						"company-id": "9219592331212583950",
						"country": "Netherlands",
						"accepts-agreement": false,
						"provide-information": true,
						"change-password": true
				},
				{
						"id": "9219592232917474526",
						"state": "Active",
						"name": "eurot494",
						"first-name": "Marjus",
						"last-name": "van Dee",
						"phone-number": "+31121212121",
						"mobile-number": "+31313131333",
						"email": "test@test.com",
						"company-id": "9219592232917474528",
						"street": "Brielselaan 69, Haven 1357",
						"zip-code": "3081AA",
						"city": "Rotterdam",
						"country": "Netherlands",
						"accepts-agreement": false,
						"provide-information": true,
						"change-password": false
				}
	 ]
}

Créer/Mettre à jour

La section suivante décrit comment utiliser l'API Coupa pour effectuer des actions sur l'utilisateur.

Créer

/api/users

La charge utile ci-dessous crée deux utilisateurs.

Payload: 
{
		"users": [
				{
						"state": "Active",
						"name": "tester123456",
						"first-name": "tester",
						"last-name": "user1",
						"phone-number": "+1(111)-234-5678",
						"mobile-number": "+1(11)-123-3456",
						"email": "testeruser@tester.com",
						"company-id": "9220538753250662192",
						"street": "12345 bethoven road",
						"zip-code": "30811",
						"city": "Rotterdam",
						"country": "United States",
						"accepts-agreement": false,
						"provide-information": true,
						"change-password": false
				},
				 {
						"name": "tester12345",
						"first-name": "testing",
						"last-name": "user",
						"phone-number": "+1(111)-234-5678",
						"mobile-number": "+1(11)-123-3456",
						"email": "tester@tester.com",
						"company-id": "9220538753250662192",
						"street": "12345 bethoven road",
						"zip-code": "30811",
						"city": "Rotterdam",
						"country": "United States",
						"accepts-agreement": true,
						"provide-information": true,
						"change-password": false
				}
		]
}
Response: 201
{
		"result": [
				{
						"type": "api.post.added",
						"description": "2 objects created."
				}
		],
		"added": 2,
		"users": [
				{
						"id": "9220538753483272432"
				},
				{
						"id": "9220538753482068122"
				}
		]
}	 

Mettre à jour

/api/users

La charge utile ci-dessous met à jour un ou plusieurs utilisateurs. 

To update one or more User at a time: 
Payload:
{
		"users": [
				{
						"id": "9220538753483272432",
						"state": "Blocked",
						"email": "testeruser-upd@tester.com",
						"accepts-agreement": true,
						"provide-information": true,
						"change-password": false
				},
				{
						"id": "9220538753482068122",
						"state": "Blocked",
						"email": "tester-upd@tester.com",
						"accepts-agreement": false,
						"provide-information": true,
						"change-password": false
				}
		]
}

Response: 200 OK
{
		"result": [
				{
						"type": "api.put.updated",
						"description": "2 objects updated."
				}
		],
		"updated": 2
}
Remarque

 Les mises à jour sont effectuées de manière souple, c'est-à-dire que si la mise à jour d'une ressource échoue, les autres peuvent réussir. ID utilisateur requis pour les mises à jour.

Les demandes réussies seront renvoyées HTTP 200 Response. Le corps de la réponse inclura la demande créée. Les demandes infructueuses seront renvoyées HTTP 400 Bad Request. Le corps de la réponse inclut les erreurs de validation au format XML.

Une partie ou la totalité de cette page peut avoir été traduite par machine. Toutes nos excuses pour les inexactitudes.

Articles associés


L'API Coupa Core

Notre API RESTful fournit un accès robuste pour lire, modifier ou intégrer vos données à la plate-forme Coupa.

Ressources

Nous avons organisé nos points de terminaison API par type d'objet : Données de référence, données transactionnelles et ressources partagées.

Ressources de données de référence

Les données de référence sont utilisées pour configurer les composants de base de Coupa tels que les utilisateurs, les fournisseurs, les comptes, et plus encore.

Ressources transactionnelles

Au fur et à mesure que les gens utilisent Coupa, des données transactionnelles telles que des demandes, des bons de commande et des factures sont créées.