Verwendung der API

Übersicht

Coupa bietet umfassenden, robusten Zugriff auf das Lesen, Bearbeiten oder Integrieren Ihrer Daten über die RESTful-API. Diese UTF-8 XML-basierte Schnittstelle ermöglicht es Ihnen, einzelne Datensätze innerhalb von Coupa zu erstellen, zu aktualisieren und Maßnahmen zu ergreifen, indem Sie einen HTTPS-Anforderungsaufruf durchführen.

Neu in Coupa Release 15

API-Schlüssel können so konfiguriert werden, dass sie API-Zugriff und -Verwaltung zulassen. Dies gibt Administratoren die Möglichkeit, den Zugriff und die Nutzung aller Coupa-APIs über einen einzigen API-Schlüssel einzuschränken. Schlüssel können auch ein Ablaufdatum haben. Wenn ein Administrator kein Ablaufdatum angibt, läuft der Schlüssel nie ab. Wenn ein Ablaufdatum angegeben ist, läuft der API-Schlüssel am Ende des Tages (Mitternacht UTC) ab.

Verwendung der Coupa-REST-API

In Coupa werden alle Daten als Geschäftsobjekt oder Ressource gespeichert, und jede Ressource hat eine Ressourcen-URL, genau wie eine Webseite. Jeder Coupa-Kunde verfügt über eine eigene URL in der Form {customer_name}.coupahost.com. Jede Ressource hat die Form/api/[Ressource]. Stellen Sie sicher, dass Sie auf die URL mit https und nicht mit http zugreifen, wenn Sie die Coupa-API verwenden.

Eine Rechnungs-API-URL sieht beispielsweise wie folgt aus:

https://{Instanzname}.coupahost.com/api/invoices

Bitte beachten Sie, dass das Anruferprogramm für die Coupa-API-Aufrufe einen sicheren API-Schlüssel benötigt. Kontaktieren Sie Ihren Coupa-Administrator oder Integrationsarchitekten, um den Schlüssel zu generieren und bereitzustellen. Bewahren Sie die API-Schlüssel sicher auf und geben Sie sie nicht an unbefugte Benutzer weiter.

Alle API-Anfragen müssen die folgenden Kopfzeilen bestehen:

•  X-COUPA-API-KEY mit Coupa-API-Schlüssel
• AKZEPTIEREN SIE die Kopfzeile mit dem Wert application/xml.

Coupa-API ermöglicht die Verwendung bestimmter Operatoren und Argumente, wie GET Supplier basierend auf Name (Präfix, Suffix, etc.) oder Erstellungsdatum, etc. Weitere Informationen finden Sie unter Erste Schritte mit APIs

Best Practice

Flache API-Formate können bei API-Aufrufen verwendet werden, um die API-Antwortnutzlast zu begrenzen. Die API von Coupa gibt standardmäßig viele Daten zurück (z. B. vollständige Objekte für Verknüpfungen). Dies führt zu Rückgabewerten, die enorm sein können, und diese Renditen können zu einer Leistungsverschlechterung führen. Dies kann ein Problem für Kunden sein, die die Fremddaten nicht benötigen, ganz zu schweigen vom unnötigen Ressourcenverbrauch. Um die Bedürfnisse unserer Kunden besser zu erfüllen, hat Coupa einen Befehl return_object=limited hinzugefügt, der eine begrenzte XML-Antwort anstelle des gesamten Schemas für ein Objekt zurückgibt.

Fehlerbehandlung / Nachrichten

Für cXML geben erfolgreiche Anfragen „http 200 OK“ zurück. Der Text der Antwort enthält die Objektdetails. Nicht erfolgreiche Anfragen geben die ungültige Anfrage der HTTP-Serie 4xx oder 5xx zurück. Der Text der Antwort enthält Validierungsfehler, die als XML formatiert sind. Das Aufrufprogramm sollte über eine Fehlerbehandlungslogik verfügen, um die Antwortmeldungen zu lesen und entsprechende Korrekturmaßnahmen zu ergreifen.

Wenn Coupa Ihre cXML-Rechnungsdatei erhält, finden die folgenden Validierungsschritte statt, bevor die Rechnung in Coupa hochgeladen wird.