• Zuletzt bearbeitet am: 25 March 2021

Benutzer-API

Verwenden Sie die Benutzer-API, um die Benutzerdaten zu erstellen, zu aktualisieren oder abzufragen.

Verwenden Sie die Benutzer-APIs, um die Benutzerdaten zu erstellen, zu aktualisieren oder abzufragen. 

Die URL für den Zugriff auf die APIs lautet : https://<instance>.cso.coupahost.com/api/users

Weitere Informationen finden Sie unter Integrations-Best Practices.

Aktionen

Verb Pfad Aktion Beschreibung
ABFRAGEN /api/users index Führt Get-Aktion aus, um alle Benutzer abzurufen
BEITRAG /api/users erstellen Erstellt einen oder mehrere Nutzer.
PUT /api/users aktualisieren Aktualisiert einen oder mehrere Benutzer . Kann Massenaktualisierungen durchführen.
ABFRAGEN /api/users/:id anzeigen Zeigt die Benutzerdaten an. 
PUT /api/users/:id aktualisierung Aktualisieren Sie jeweils einen Benutzer mit der ID

Elemente

Dies sind die Elemente, die für die Benutzer-API verfügbar sind

Feldname Feldbeschreibung Anf. Eindeutig? Zulässige Werte In Aus  * Typ
iD

ID des Benutzers

  Ja     ja ganze Zahl
status Status des Benutzers    

Blockiert, Aktiv, Deaktiviert, Entfernt  (Groß-/Kleinschreibung beachten)

ja ja zeichenfolge
name Der Anmeldename des Benutzers. Einmal eingestellt kann nicht geändert werden.   Ja     ja zeichenfolge
vorname Der Vorname des Benutzers       ja    
nachname Der Nachname des Benutzers       ja    
telefonnummer Telefonnummer des Benutzers       ja ja zeichenfolge
handynummer Die Mobilnummer des Benutzers       ja    
e-Mail E-Mail des Benutzers. Nach dem Einstellen kann es nicht mehr geändert werden.         ja zeichenfolge
company-id Die Unternehmens-ID des Benutzers. Nach dem Einstellen kann es nicht mehr geändert werden            
straße Straßenteil der Benutzeradresse       ja ja zeichenfolge
pLZ Postleitzahl Teil der Benutzeradresse       ja ja zeichenfolge
ort Stadtteil der Benutzeradresse       ja ja zeichenfolge
land Länderteil der Benutzeradresse       ja ja zeichenfolge
schlüsselwörter Mit dem Benutzer verknüpfte Schlüsselwörter       ja ja zeichenfolge
external-user-name Der dem Benutzer zugewiesene externe Benutzername.         ja  
akzeptiert-Vereinbarung Weist darauf hin, ob der Benutzer die erforderlichen Vereinbarungen akzeptiert hat oder nicht.       ja ja  
informationen bereitstellen Weist darauf hin, ob der Benutzer bei der nächsten Anmeldung Benutzerinformationen angeben soll oder nicht.       ja ja  
change-password Gibt an, ob der Benutzer bei der nächsten Anmeldung sein Passwort ändern soll oder nicht.       ja    
invoicing_user Rechnungsstellung an Benutzer alle ja boolean
Hinweis

 Die Antwortnutzlast zeigt keine Nullwerte an.

Beispiele

In diesem Beispiel haben wir nach einer Benutzer-API gefragt. Wir sind auf die URL GEKOMMEN: 

https://<instance>.cso.coupahost.com/api/users 

Antwort des Benutzers ABRUFEN

{

		"total": 3,

		"users": [

				{

						"id": "9219595862193003588",

						"state": "Aktiv",

						"name": "dekke434",

						"Vorname": "Arjan",

						"last-name": "Goud",

						"phone-number": "+310987898789",

						"mobile-number": "+31(0) 6 98876554",

						"email": "a.goud@deeder.com",

						"company-id": "9219592232917474305",

						"Straße": "IJsseldijk west 66",

						"PLZ": "2935AR",

						"city": "Ouderkerk aan den IJssel",

						"Land": "Niederlande",

						"accepts-agreement": falsch,

						"provide-information": falsch,

						"change-password": falsch

				},

				{

						"id": "9219595145795283441",

						"state": "Aktiv",

						"name": "Urkunde",

						"Vorname": "Arjan",

						"last-name": "Urkunde",

						"phone-number": "+313132323133",

						"email": "mh@test.nl",

						"company-id": "9219592331212583950",

						"Land": "Niederlande",

						"accepts-agreement": falsch,

						"provide-information": wahr,

						"change-password": wahr

				},

				{

						"id": "9219592232917474526",

						"state": "Aktiv",

						"name": "eurot494",

						"Vorname": "Marjus",

						"last-name": "van Dee",

						"phone-number": "+31121212121",

						"mobile-number": "+31313131333",

						"email": "test@test.com",

						"company-id": "9219592232917474528",

						"Straße": "Brielselaan 69, Haven 1357",

						"PLZ": "3081AA",

						"city": "Rotterdam",

						"Land": "Niederlande",

						"accepts-agreement": falsch,

						"provide-information": wahr,

						"change-password": falsch

				}

	 ]

}

Erstellen/Aktualisieren

Im Folgenden wird beschrieben, wie Sie die Coupa-API zum Ausführen von Aktionen für den Benutzer verwenden können.

Erstellen

/api/users

Die unten stehende Nutzlast erstellt zwei Benutzer.

Nutzdaten: 

{

		"users": [

				{

						"state": "Aktiv",

						"name": "tester123456",

						"first-name": "Tester",

						"last-name": "Benutzer1",

						"phone-number": "+1(111)-234-5678",

						"mobile-number": "+1(11)-123-3456",

						"email": "testeruser@tester.com",

						"company-id": "9220538753250662192",

						"Straße": "12345 bethoven Straße",

						"PLZ": "30811",

						"city": "Rotterdam",

						"Land": "Vereinigte Staaten",

						"accepts-agreement": falsch,

						"provide-information": wahr,

						"change-password": falsch

				},

				 {

						"name": "tester12345",

						"first-name": "Testen",

						"last-name": "Benutzer",

						"phone-number": "+1(111)-234-5678",

						"mobile-number": "+1(11)-123-3456",

						"email": "tester@tester.com",

						"company-id": "9220538753250662192",

						"Straße": "12345 bethoven Straße",

						"PLZ": "30811",

						"city": "Rotterdam",

						"Land": "Vereinigte Staaten",

						"accepts-agreement": wahr,

						"provide-information": wahr,

						"change-password": falsch

				}

		]

}

Antwort: 201

{

		"result": [

				{

						"type": "api.post.added",

						"Beschreibung": "2 Objekte erstellt."

				}

		],

		"hinzugefügt": 2.

		"users": [

				{

						"id": "9220538753483272432"

				},

				{

						"id": "9220538753482068122"

				}

		]

}	 

Aktualisieren

/api/users

Die folgende Nutzlast aktualisiert einen oder mehrere Benutzer. 

So aktualisieren Sie jeweils einen oder mehrere Benutzer: 

Nutzdaten:

{

		"users": [

				{

						"id": "9220538753483272432",

						"state": "Abgesperrt",

						"email": "testeruser-upd@tester.com",

						"accepts-agreement": wahr,

						"provide-information": wahr,

						"change-password": falsch

				},

				{

						"id": "9220538753482068122",

						"state": "Abgesperrt",

						"email": "tester-upd@tester.com",

						"accepts-agreement": falsch,

						"provide-information": wahr,

						"change-password": falsch

				}

		]

}



Antwort: 200 OK

{

		"result": [

				{

						"type": "api.put.updated",

						"Beschreibung": "2 Objekte aktualisiert."

				}

		],

		"aktualisiert": 2

}
Hinweis

 Aktualisierungen werden auf nachsichtige Weise durchgeführt, d. h. wenn die Aktualisierung einer Ressource fehlschlägt, können die anderen erfolgreich sein. Für Aktualisierungen ist eine Benutzer-ID erforderlich.

Erfolgreiche Anfragen geben die HTTP-200-Antwort zurück. Der Text der Antwort enthält die erstellte Anforderung. Bei nicht erfolgreichen Anfragen wird http 400 Bad Request zurückgegeben. Der Text der Antwort enthält Validierungsfehler, die als XML formatiert sind.

Vergleichbare Artikel


Fakten-Blätter-API

25 March 2021

Verwenden Sie die Fact Sheets-API, um die Fact Sheets und die zugehörigen (Zeilen / Felder) Daten zu erstellen, zu aktualisieren oder abzufragen.

Felder-API

25 March 2021

Verwenden Sie die Feld-API, um die Felder und zugehörigen (Zeilen) Daten zu erstellen, zu aktualisieren oder abzufragen.

Markt API

25 March 2021

Verwenden Sie die Markt-API, um die Märkte zu erstellen, zu aktualisieren oder abzufragen.

Unternehmens-API

25 March 2021

Verwenden Sie die Unternehmens-API, um die Unternehmensdaten zu erstellen, zu aktualisieren oder abzufragen.

Hinweis: Einige Inhalte wurden maschinell übersetzt.