API 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

Éléments

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

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
}

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.