Erste Schritte mit der API

Allgemeine Informationen zur Verwendung der Coupa-API und wann Sie CSV verwenden sollten.

Authentifizierung

Alle Daten werden als Geschäftsobjekt oderRessource gespeichertund jede Ressource hat eineRessourcen-URL, genau wie eine Webseite, wo jede Ressource im Formular enthalten ist./api/{resource_name}. Stellen Sie sicher, dass Sie auf die URL zugreifen,https://anstatt http:// wenn Sie die Coupa-API verwenden. Jeder Coupa-Kunde hat seine eigene URL des Formulars {instance_name}.coupahost.com. Beispiel: https://companyname.coupahost.com/api/users.

Coupa empfiehlt die Authentifizierung von API-Anforderungen mit OpenID Connect.

Vor der Unterstützung für OpenID Connect wurden API-Anforderungen in der Vergangenheit durch einenin Coupa generierten eindeutigen API-Schlüsselauthentifiziert. Diese Methode wird weiterhin unterstützt, ist aber in R35 vollständig veraltet. Alle API-Anforderungen, die diese Authentifizierungsmethode verwenden, müssen einen X-COUPA-API-KEY"-Header, einen API-Schlüssel und den ACCEPTHeader mit dem Wert übergeben, der application/xmlfür XML-Antworten oder für JSON-Antworten auf application/json festgelegt ist.  Ein Administratorbenutzer kann einen Schlüssel im Abschnitt API-Schlüsselder Registerkarte Konfiguration erstellen. Der Schlüssel ist ein 40-stelliger alphanumerischer Code mit Berücksichtigung der Groß-/Kleinschreibung und ist einem API-Benutzer zugeordnet, der einem Administratorbenutzer auf Coupa entspricht. Alle Änderungen an Ressourcen über die API werden dem API-Benutzer zugewiesen.

API-Schlüsselsicherheit kann beispielsweise konfiguriertwerden, indem Ablaufdaten festgelegt, ein Schlüssel widerrufen und konfiguriert wird, auf welche Objekte und Methoden ein Schlüssel Zugriff hat.

Hinweis

API-Schlüssel-Verfall
          R32 - OAuth2.0 ist die einzige verfügbare Option für Neukunden
          R34 - neue API-Schlüssel können nicht mehr an bestehende Kunden ausgegeben werden
          R35 - API-Schlüssel werden nicht mehr unterstützt
          Weitere Details

Hinweis

Überprüfen Sie immer das Vorhandensein von Elementen in XML/JSON, bevor Sie den Wert abrufen, da sich die Coupa-Payloadstruktur in Zukunft ändern kann, sodass bestimmte Felder, die keine oder Nullwerte haben, nicht angezeigt werden.

Welche Methoden werden von der API unterstützt?

GET (Daten lesen) - Eine HTTP GET-Anforderung fragt Coupa ab und gibt Informationen im JSON- oder XML-Format zurück.  Eine Anforderung am Ressourcenstamm listet die ersten 50 Objekte ab ID 1 auf. Verwenden Sie diese Argumente, um die Abfrage zu optimieren.

PUT (Daten aktualisieren) - Eine HTTP-PUT-Anforderung an/api/{resource}/{id}versucht, eine Ressource zu aktualisieren. Pro Anforderung kann nur eine Ressource aktualisiert werden, und die Payload sollte ein JSON- oder XML-Dokument mit den zu aktualisierenden Elementen sein. Nicht alle Felder sind über die API verfügbar und alle referenzierten Daten müssen bereits vorhanden sein oder der Wert wird nicht geändert.

POST (Daten erstellen) - Eine HTTP-POST-Anforderung an den Ressourcenstamm mit einer JSON- oder XML-Payload versucht, eine neue Ressource zu erstellen. Wenn erfolgreich, wird die Ressource mit der neuen ID zurückgegeben, die von Coupa generiert wird.

Hinweis

Das Löschen von Datenwird für keine Ressource über die API unterstützt. Benutzer können eine Teilmenge von Ressourcen mithilfe einer PUT-Anforderung deaktivieren.

Wann sollte ich die API verwenden?

Die Coupa-API ermöglicht Ihnen das Erstellen, Aktualisieren und Abfragen einzelner Einträge und wird hauptsächlich zur Verwaltung von Objekten in Coupa verwendet. Mit Standard-RESTful-Aktionen und endgültigen Ein- und Ausgängen ist es die einfache Tagesoption für Nicht-Massenaktionen. Auf diese Methoden kann jederzeit zugegriffen werden, und integrierte Tools ermöglichen es Ihnen, einfach zu überprüfen, ob ein Aufruf erfolgreich durchlaufen wird, oder die Antwortausgabe zu minimieren. Dies wird hauptsächlich verwendet, um einfache individuelle Aktualisierungen vorzunehmen oder Daten abzufragen.

XML vs. JSON

Coupa unterstützt sowohl XML als auch JSON.  Im Folgenden finden Sie einige grundlegende Informationen zu jedem:

Extensible Markup Language (XML) ist ein Satz von Regeln zum Codieren von Dokumenten in maschinenlesbarer Form. XMLs Design-Ziele heben Einfachheit, Allgemeinheit und Benutzerfreundlichkeit über das Internet hervor.

JavaScript Object Notation (JSON) ist ein leichter, textbasierter offener Standard für den lesbaren Datenaustausch. Sie wird von der Programmiersprache JavaScript abgeleitet, um einfache Datenstrukturen und assoziative Arrays, so genannte Objekte, darzustellen. Trotz seiner Beziehung zu JavaScript ist es sprachunabhängig, mit Parsern für die meisten Programmiersprachen.

JSON ist weniger ausführlich als XML, da XML öffnende und schließende Tags (oder in einigen Fällen weniger ausführliche selbstschließende Tags) erfordert, und JSON verwendet Name/Wert-Paare, die durch "{" und "}" für Objekte, "[" und "]" für Arrays, "," für getrennte Paare und ":" für die Trennung von Name und Wert kurz definiert sind.

Unterschiede zwischen XML und JSON in Coupa

Beispielanforderungen/Antworten - XML vs. JSON

Hinweis

Unabhängig davon, welche Methode Sie wählen, müssen Sie für die Coupa-API sowohl Ihren Inhaltstyp als auch Ihre Inhaltsakzeptor-Kopfzeilen auf denselben Typ festlegen. Nicht mischen und abgleichen.

Verwenden von GraphQL

GraphQL ist eine offene Spezifikation für eine API-Abfragesprache (also die "QL"-Referenz), mit der Sie Ihre Integrationen reaktiver machen können als je zuvor, indem Sie die Möglichkeit haben, die benötigten Daten anzufordern und nichts mehr. GraphQL kann auch die Anzahl der Anrufe und der zugehörigen Hin- und Rückfahrten reduzieren, indem Sie alle benötigten Ressourcen in einer einzigen oder wenigen Anrufen abrufen.

Weitere Informationen finden Sie unter Einführung in GraphQL .

Wann sollte ich SFTP-Flatfiles verwenden?

Mit Flat Files können Sie viele Datensätze über eine einzige Transaktion laden. Sobald eine Integration eingerichtet ist, wird sie basierend auf den festgelegten Parametern automatisch ausgeführt. Integrationsläufe und Fehler werden in der App verwaltet und geben Einblick in die Anzahl der hinzugefügten Einträge, die Fehlerdetails und die Person, die automatisch über den Fehler kontaktiert wurde. Dies wird hauptsächlich verwendet, um Massenaktualisierungen oder Ergänzungen zu wichtigen Komponenten des Produkts wie Benutzern oder Lieferanten vorzunehmen.

Zusätzliche Informationen

wiki.tree(page.path)

API-Operatoren

16 August 2022

Coupa unterstützt eine Reihe von Operatoren, damit Sie präzise Abfragen durchführen können.

API-Rückgabeformate

03 February 2022

Verwenden Sie das flache API-Format von Coupa, um die Datenmenge zu reduzieren, die Sie während einer Abfrage erhalten.

API-Schlüsselsicherheit

14 January 2022

Verbesserte API-Schlüsselsicherheit mit Ablauf von API-Schlüsseln und vom Administrator festgelegten Berechtigungen für APIs.

Namespace des benutzerdefinierten Felds

18 April 2019

Alle neuen benutzerdefinierten Felder werden einem Namespace für benutzerdefinierte Felder hinzugefügt, um Namenskonflikte zu vermeiden und vom Kunden hinzugefügte Felder leichter identifizierbar zu machen.

Argumente

24 April 2017

Erfahren Sie mehr über die Argumenttypen, die Coupa in Verbindung mit Operatoren unterstützt.

Abfrageoptionen

21 October 2016

Erfahren Sie, wie Sie mithilfe von Abfragen die benötigten Daten schnell identifizieren und abrufen können.

Besondere Aktionen und API-Hinweise

21 October 2016

Zusätzliche Informationen zur Verwendung der Coupa-API.

Parts or all of this page might have been machine-translated. We apologize for any inaccuracies.