Authentifizierung
Alle Daten werden als Geschäftsobjekt oder Ressource gespeichert, und jede Ressource hat eine Ressourcen-URL, genau wie eine Webseite, wobei jede Ressource die Form/api/{resource_name} hat.
Stellen Sie sicher, dass Sie auf die URL mit https://
anstelle von http://zugreifen
, wenn Sie die Coupa-API verwenden. Jeder Coupa-Kunde verfügt über eine eigene URL in der Form {instance_name}.coupahost.com
. Beispiel: https://companyname.coupahost.com/api/users
.
Coupa empfiehlt, API-Anfragen mit OpenID Connect zu authentifizieren.
In der Vergangenheit wurden API-Anfragen vor der Unterstützung von OpenID Connect durch einen eindeutigen API-Schlüssel authentifiziert, der in Coupa generiert wurde. Diese Methode wird weiterhin unterstützt, wird jedoch in R35 vollständig veraltet sein. Alle API-Anforderungen, die diese Authentifizierungsmethode verwenden, müssen einen X-COUPA-API-KEY
" -Header, einen API-Schlüssel und den ACCEPT-HEADER mit dem Wert
application/xml
für XML-Antworten oder application/json
für JSON-Antworten übergeben. Ein Schlüssel kann von einem Admin-Benutzer aus dem Abschnitt API-Schlüssel der Registerkarte Setup erstellt werden. Der Schlüssel ist ein 40 Zeichen langer alphanumerischer Code mit Groß-/Kleinschreibung und ist einem API-Benutzer zugeordnet, der einem Admin-Benutzer auf Coupa entspricht. Alle Änderungen an Ressourcen über die API werden dem API-Benutzer zugeordnet.
Die API-Schlüsselsicherheit kann beispielsweise konfiguriert werden, indem Ablaufdaten festgelegt, ein Schlüssel widerrufen und konfiguriert werden, auf welche Objekte und Methoden ein Schlüssel Zugriff hat.
Verfall von API-Schlüsseln
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
Überprüfen Sie immer das Vorhandensein von Elementen in XML/JSON, bevor Sie den Wert abrufen, da sich die Coupa-Nutzlaststruktur in Zukunft ändern kann, sodass bestimmte Felder, die keine oder Nullwerte aufweisen, nicht angezeigt werden.
Welche Methoden werden von der API unterstützt?
GET (Read Data) - 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 beginnend mit ID 1 auf. Verwenden Sie diese Argumente, um die Abfrage zu verfeinern.
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 Nutzlast 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 (Create Data) - Eine HTTP-POST-Anforderung an den Ressourcenstamm mit einer json - oder XML-Nutzlast versucht, eine neue Ressource zu erstellen. Bei Erfolg wird die Ressource mit der neuen ID zurückgegeben, die von Coupa generiert wird.
Das Löschen von Daten wird für keine Ressource über die API unterstützt. Benutzer können eine Teilmenge von Ressourcen mithilfe einer PUT-ANFRAGE deaktivieren.
Wann sollte ich die API verwenden?
Die Coupa-API ermöglicht das Erstellen, Aktualisieren und Abfragen einzelner Einträge und wird hauptsächlich zum Verwalten von Objekten in Coupa verwendet. Mit Standard-RESTful-Aktionen und definitiven Inputs und Outputs ist es die einfache tägliche Option für Non-Bulk-Aktionen. Auf diese Methoden kann jederzeit zugegriffen werden, und es sind Tools integriert, mit denen Sie einfach überprüfen können, ob ein Anruf erfolgreich durchlaufen wird, oder die Ausgabe von Antworten minimieren können. Dies dient in erster Linie dazu, einfache Einzelaktualisierungen vorzunehmen oder Daten abzufragen.
XML vs. json
Coupa unterstützt sowohl XML als auch json. Nachfolgend finden Sie einige grundlegende Informationen zu den einzelnen:
Die Extensible Markup Language (XML) ist ein Regelwerk zur Kodierung von Dokumenten in maschinenlesbarer Form. XMLs Designziele betonen Einfachheit, Allgemeingültigkeit und Benutzerfreundlichkeit über das Internet.
JavaScript Object Notation (json) ist ein leichter, textbasierter offener Standard, der für den Austausch von vom Menschen lesbaren Daten entwickelt wurde. Es leitet sich von der Programmiersprache JavaScript ab, um einfache Datenstrukturen und assoziative Arrays, sogenannte Objekte, darzustellen. Trotz seiner Beziehung zu JavaScript ist es sprachunabhängig, wobei Parser für die meisten Programmiersprachen verfügbar sind.
Json ist weniger ausführlich als XML, da XML das Öffnen und Schließen von Tags (oder in einigen Fällen weniger ausführliche selbstschließende Tags) erfordert, und json verwendet Name/Wert-Paare, die prägnant durch "{" und "}" für Objekte, "[" und "]" für Arrays, "," zur Trennung von Paaren und ":" zur Trennung von Name und Wert abgegrenzt werden.
Unterschiede zwischen XML und json in Coupa
Beispielanfragen/-antworten - XML vs. json
Unabhängig davon, für welche Methode Sie sich entscheiden, erfordert die Coupa-API, dass Sie sowohl Ihre Content-Typ- als auch Ihre Content-Accept-Header auf denselben Typ setzen. Nicht kombinieren.
Benutzung von GraphQL
GraphQL ist eine offene Spezifikation für eine API-Abfragesprache (daher die "QL" -Referenz), mit der Sie Ihre Integrationen reaktionsfähiger als je zuvor machen können, indem Sie die Möglichkeit haben, die benötigten Daten anzufordern und nicht mehr. GraphQL kann auch die Anzahl der Anrufe und der damit verbundenen Hin- und Rückfahrten reduzieren, indem alle benötigten Ressourcen in einer einzigen oder wenigen Anrufen abgerufen werden.
Weitere Informationen finden Sie unter Einführung von GraphQL.
Wann sollte ich SFTP Flat Files verwenden?
Mit flachen Dateien können Sie viele Datensätze über eine einzige Transaktion laden. Sobald eine Integration eingerichtet ist, wird sie basierend auf den eingestellten Parametern automatisch ausgeführt. Integrationsläufe und Fehler werden in der App verwaltet und geben Aufschluss über die Anzahl der hinzugefügten Teilnehmer, Fehlerdetails und darüber, wer automatisch wegen des Fehlers kontaktiert wurde. Dies wird in erster Linie verwendet, um Massenaktualisierungen oder -ergänzungen zu wichtigen Komponenten des Produkts wie Benutzern oder Lieferanten vorzunehmen.
Zusätzliche Informationen
wiki.tree(page.path)
Coupa unterstützt eine Reihe von Operatoren, mit denen Sie präzise Abfragen durchführen können.
Verwenden Sie das flache API-Format von Coupa, um die Datenmenge zu reduzieren, die Sie während einer Abfrage erhalten.
Verbesserte API-Schlüsselsicherheit mit Ablauf des API-Schlüssels und vom Administrator angegebenen Berechtigungen für APIs.
Kundenspezifischer Feld-Namespace
Alle neuen benutzerdefinierten Felder werden zu einem benutzerdefinierten Feld-Namespace hinzugefügt, um Namenskonflikte zu vermeiden und vom Kunden hinzugefügte Felder leichter identifizierbar zu machen.
Erfahren Sie mehr über die Arten von Argumenten, die Coupa in Verbindung mit Operatoren unterstützt.
Erfahren Sie, wie Sie Abfragen verwenden können, um die benötigten Daten schnell zu identifizieren und abzurufen.
Spezielle Aktionen und API-Notizen
Weitere Informationen zur Verwendung der Coupa-API.
- Inhalt
-
Coupa Core API
-
Ressourcen
-
Referenzdaten-Ressourcen
- Kontovalidierungsregeln-API (/account_validation_rules)
- Kontoarten API (/account_types)
- Benutzer-API (/users)
- Konten-API (/accounts)
- Adress-API (/addresses)
- Inhaltsgruppen-API (/business_groups)
- Steuerregistrierungs-API (/tax_registrations)
- Ankündigungen API (/Announcements)
- Budgetpositionen-API (/budget lines)
- Währungen-API (/currencies)
- Geschäftseinheiten-API (/business_entities)
-
Lieferanten-API (/suppliers)
- API der Diversity Association
- Diversitätskategorie- und Unterkategorie-APIs
- API der Diversity-Zertifizierungsstelle
- Proxy-Lieferanten-API
- Punchout-Site-API
- Lieferantenartikel-API (/supplier_items)
- Lieferantenartikel - Beispielanrufe
- Lieferanten-Zahlungsempfänger-API
- Lieferantenstandorte API (/supplier_sites)
- Lieferantenbenutzer-API
- Lieferanten-API-Beispielaufrufe
- API für den Kontakt zum Kundendienst
- Zahlungsbedingungen API (/payment_terms)
- Zahlungsempfänger-Adressen-API (/Lieferanten/Adressen)
- Versandbedingungen API (/shipping_terms)
- Datendateiquellen-API (/data_file_sources)
- Abteilungs-API (/Abteilungen)
- Wechselkurs-API (/exchange_rates)
- Finanzielle Gegenparteien API (/financial_counterparties)
- Artikel-API (/items)
- Rechtsdokumente API (/legal_documents)
- Suchwerte-API (/lookup_values)
- Übereinstimmende Zuordnungen API (/matching_allocations)
- Projekte-API (/projects)
- Preislisten-API
- Lieferanteninformations-API (/supplier_information)
- Lieferanteninformationsseiten-API (/supplier_information_sites)
- Lieferanteninformationen zu Steuerregistierungen API (/supplier_information_tax_registrations)
- Aufgaben-API (/tasks)
-
Transaktionsressourcen
- Lieferavise API (/asn)
- Genehmigungs-API (/Genehmigungen)
-
Ausgaben-API (/expense_reports)
- Ausgaben-API-Beispielaufrufe
- Ausgaben-Artefakt-API
- Spesenpositionen-API
- Ausgaben für Teilnehmer-API
- Ausgabenteilnehmertyp-API
- Spesenbarvorschuss-API
- Spesenabrechnungs-API
- Spesenkategorie-API
- Übersetzung der Spesenkategorie-API
- API für die Zuordnung von Spesenpositionen
- Spesenposition-Teilnehmer-API
- API für Barvorschuss in der Spesenposition
- Importierte Daten-API der Spesenposition
- API für die Kilometerzuweisung in der Ausgabenposition
- API für Kilometerstand der Spesenposition
- Spesenposition Tagessatz API
- Steuer-API der Spesenposition
- Virtuelle Karten-API der Ausgabenposition
- API für Vorabgenehmigung von Spesen
- API für Spesenvorabgenehmigungszeilen
- API für die Vorabgenehmigung von Spesenabrechnungen
- Reise-API abrechnen
- Reise-Segment-API abrechnen
- API für Verstöße gegen Spesenvorgaben
- Expense Virtual Card API
- Aufgeschlüsselte Spesenposition-API
- Auditstatus-API
- API für juristische Person
- Gebühren-API (/Gebühren)
- Rohstoff-API (/commodities)
-
Verträge API (/contracts)
- Vertragszuordnungs-API
- API der Vertragsklausel
- Referenz-API der Vertragsklausel
- Vertragsdetails - API
- Vertragsstreitigkeit-API
- API der Vertragspartei
- Kontakt-API der Vertragspartei
- Vertragsvorlage-API (/contracts/templates)
- Vertragstypen-API
- Vertragslaufzeiten API
- API der Länderunterabteilung
- Geistiges Eigentum und Daten-API
- API für Insights zu Gründen
- API für Insight-Ereignisse zu Gründen
- Beispielaufrufe der Vertrags-API
- Coupa Pay-Auszüge-API (/coupa_pay/statements)
- Benutzerdefinierte Objekt-API (/custom_objects/id)
- Zykluszählungszeilen-API (/cycle_count_lines)
- Datendateiquellen-API (/data_file_sources)
- Standardmäßige Empfangsstandort-API (/Standardmäßiger Empfangsstandort)
- Standardmäßige Empfängerstandort-API (/default_receiving_locations)
-
INVOICES-API (/INVOICES)
- API für fehlgeschlagene Toleranzen
- API für die Rechnungsposition
- Eingehende Rechnung API
- API für die Rechnungsgebührzuordnung
- API für Rechnungsgebühr
- Rechnungszahlungen API-Beispielaufrufe
- Rechnungs-API-Beispielaufrufe
- Registrierte Unternehmens-API
- Steuerposition-API
- Quellensteuerposition API
- Grund-API anfechten
- Easy-Form-Antworten-API (/easy_form_responses)
- Kreditoren-API (/payables/)
- Integrations-API (/integrations)
-
Empfangs-API
- Bestandsverbrauchs-API (/inventory_consumptions)
- API-Beispielaufrufe empfangen
- API für Bestandstransaktionen
- Bestandsübertragungen API (/inventory_transfers)
- Empfangs-Transaktions-API (/receiving_transactions)
- Rückgabeanforderungen API (/return_requests)
- Zurück zur Lieferantentransaktionen-API (/return_to_supplier_transactions)
- Anpassungscode-API
- Bestandsanpassungs-API (/inventory_adjustments)
- Picklisten/Erfüllungsreservierungs-API (/Picklisten)
- Objektübersetzungs-API (/uoms/uom_id/translations)
-
API für Bestellungen (/purchase_orders)
- Bestellpositionszuordnungen - API
- Bestellpositionen API
- Bestellpositionsänderungs-Steuerdetail-API
- Bestellpositions-Steuerdetail-API
- Änderungs-API für Bestellung
- Bestellpositionsänderungs-API
- API-Beispielaufrufe für die Überarbeitung von Bestellungen
- API-Beispielaufrufe für Bestellungen
- Bestellbetrag Position API
- Anforderungs-API (/requisitions)
- Auftragsbestätigungen API (/order_header_confirmations)
- Bestelllisten-API (/order_pads)
- Zahlungs-API (/coupa_pay/payments )
- Beschaffungs-API (/quote_requests)
- Wareneingangsanfragen API (/receipt_requests)
- Services Procurement API (/services_procurement)
- Feed-API mit Berücksichtigung des Lieferantenrisikos (/supplier_risk_aware_feed)
-
Geteilte Ressourcen
- Betragsbestandteil-API
- Bestandskennzeichnungs-API
- Anhangsdatei-API
- Anhänge-API
- Kommentare-API
- Budgetzeitraum API
- API für den Großmengenpreis
- Maßeinheit API
- Chargen-API für Anzahl der Zyklen
- Konto-API für Anbieter für elektronische Signaturen
- ExtraLineAttributes:: OrderLineAttribute-API
- Formular-API
- Mitgliedschafts-API für Gruppeneinkäufe
- Zahlungs-API
- Zwecke API
- RA-Risikoanfrage-API
- RA-Risikoanfrage-Beziehungs-API
- RA-Risikoanfrage-Score-API
- RA CLMA-Vertrags-API
- Rückführung von Anfragetext-API
- Zeitplan-Positions-API
- Änderungs-API für Lieferantenbestellungen
- Kennzeichen-API
- Tagging-API
- Kontokategorie-API
- Kontogruppen-API
- Alternative API
-
Referenzdaten-Ressourcen
- OAuth 2.0 und OIDC
-
Erste Schritte mit der API
- API-Operatoren
- API Rückgabeformate
- Argumente
- Kundenspezifischer Feld-Namespace
- Unterschiede zwischen XML und json in Coupa
- Ausnahmebehandlung und Fehlercodes
- Einführung von GraphQL
- Optionen für die Abfrage
- Beispielanfragen/-antworten - XML vs. json
- Spezielle Aktionen und API-Notizen
- API-Schlüsselsicherheit
- Orchestration Documents
-
Ressourcen
- Kern-API und CSV-Downloadformate
-
Coupa Core Flat Files (CSV)
-
Import von Flat File (CSV)
- Kontovalidierungsregeln importieren
- Adressenimport
- Import Lieferavis
- Genehmigungskette Import
- Anpassung der Budgetposition Import
- Import von Budgetpositionen
- Geschäftseinheit-Import
- Warengruppenimport
- Warengruppenübersetzungsimport
- Import der Inhaltsgruppe
- Vertragsimport
- Abteilungen importieren
- Unternehmensimport
- Wechselkursimport
- Dynamischer Kategorielimit-Import für Ausgabenaktion
- Import der Spesenkategorie
- Import von Steuersätzen für Ausgabenkategorien
- Import der Übersetzung der Spesenkategorie
- Kategoriezuordnungsimport für Spesenimport
- Transaktionsfiltertyp-Zuordnungsimport für Spesenimport
- Import von Benutzerzuordnungen für Spesenimport
- Import von Auslagenkilometerdaten
- Zahlungsimport für Spesen
- Import externer Bestellungen
- Externe Zahlungen
- Formulare (Einfache Formulare) Import
- Integrationskontakte importieren
- Integrationsimport
- Bestandsbilanz-Import
- Chargenimport der Bestandsbilanz
- Import von Bestandstransaktionen (Belegen)
- Import von Rechnungszahlungen
- Rechnungsimport
- Artikelimport
- Import der juristischen Person
- Ladegerät für rechtsgültigen Zahlungsbeleg
- Suchwerte-Import
- Objektinstanz-Import
- Objektübersetzungsimport
- Bestellbestätigungsimport
- Payables :: Zuordnung
- Payables :: Extern :: Zu zahlender Import
- Zahlungsimport
- Zahlungsbedingungen-Import
- Projektimport
- Bestelländerung Import
- Angebotsanforderungszeilenimport
- Angebotslieferanten-Import
- Zahlungsempfängeradressen-Import
- Anforderungen importieren
- Service-/Arbeitszeitblatt-Import
- Versandfähige Verfolgung Importieren Sie
- Risk Aware-Feed-Import des Lieferanten
- Lieferanten-Site-Import
- Lieferanten-Import
- Import des Steuercodes
- Import der Regel für den Steuercode
- Steuersatz-Import
- Steuerreferenz-Import
- Steuerregistrierungsimport
- Cashflow-Import im Treasury
- Import von Treasury-Rohstoffsätzen
- Import von Treasury-Kreditspreads
- Treasury Devisenterminkurse Import
- Treasury Zinssätze Import
- Import von Treasury-Zinsvolatilitäten
- Import von Treasury-Geldmarktguthaben
- Import für Benutzergruppe
- Benutzer importieren
- Import des Lagerorts
- Import des Lagerorts
- Kontoimport
- Kontotyp (CoA) Import
-
Export von flachen Dateien (CSV)
-
Standard CSV Exports
- Warenexport
- Export Verträge
- Coupa Pay-Gebühren-Export
- Coupa Pay Pay-Zahlungsexport
- Export von Coupa Pay-Auszügen
- Datendateiquellenexport
- Delegierungen exportieren
- Easy Form-Widget-Antwort-Export
- Wechselkurs-Export
- Export von Vorabgenehmigungen für Spesen
- Export Spesenabrechnungen
- Integrationsfehler-Export
- Export des Integrationsverlaufsdatensatz
- Bestandsbilanz-Export
- Bestandsbuchungen (Belege) Export
- Rechnungsexport
- Element-Export
- Suchwerte-Export
- Objektübersetzung Export
- Export der Änderung der Auftragskopfzeile
- Bestellkopfzeile - Bestätigungsexport
- Bestellpositionsänderungszuweisungsexport
- Bestellpositionsänderungsexport
- Export der Bestellpositionsbestätigung
- Payables :: Zuordnung
- Payables :: Spesen
- Payables :: Export der Vorabgenehmigung von Ausgaben
- Verbindlichkeiten Rechnungsexport
- Beschaffungsmeilenstein-Export
- Projektexport
- Projektverknüpfungsex
- Export von Bestellungen
- Zahlungsempfängeradressen Export
- Anforderungen Export
- Zeitplan-Positionsexport
- Sourcing-Export
- Export der Angebotsanfrage für die Beschaffung
- Export von Beschaffungsangebotsantworten
- Direkter Export des Lieferanten-Diversitätsberichts
- Indirekte Ausgaben des Lieferanten-Diversitätsberichts Export
- Zusammenfassungen des Lieferanten-Diversitätsberichts exportieren
- Lieferanteninformationen - Export
- Lieferanteninformationenseite
- Lieferantenstandort
- Export des Steuercodes
- Export der Regel für den Steuercode
- Steuerregistrierungsexport
- TCS-Steuerzeilenexport
- Export für Benutzergruppe
- Arbeitsbestätigung/Kopf (Kopf des Service-/Stundennachweises) Export
- Export der Arbeitsbestätigung/-position (Service-/Arbeitszeitblattposition)
- Kontoart Export
- Lieferavise Export
-
Standard CSV Exports
- Erste Schritte
-
Import von Flat File (CSV)
-
Treasury Integrations
-
Treasury-CSV-Formatbeschreibungen (klassisch)
- CSV-Tabellen-Export-Dateiformat
- Feiertags-Import-CSV-Format
- IC-Salden - Währungskurse importieren - CSV-Format
- IC-Netting - Währungskurse importieren - CSV-Format
- IC-Netting - Zahlungsexport - CSV-Format
- IC Recon - Rechnungsexport - CSV-Format
- IC Recon Server CSV-Formate importieren
- LMPLANNING - Liquiditätsplanungsdatenimport
- System - Import von Devisen- und Zinsszenarien
- System - Marktdatenimport
- TTContract Zins- und Tilgungsplan Import
- TTContract Leasing Zahlungsplan Import
- TTGL-Buchungsexport-CSV-Format
- Kontoauszugsimport - CSV-Format
- Cashflow-Datenimport CSV-Formate
- Cashflow-Export - CSV-Format
- Treasury-API-Dokumentation anzeigen
-
Treasury-CSV-Formatbeschreibungen (klassisch)
- Coupa Core User Authentication (SSO)
- CCW Flat Files (CSV)
- The CCW API
- Coupa Core Application IP-Adressen
- Bauen Sie auf der Coupa-Plattform auf
- Risk Assess Quick Integration
- The CSO API
Hinweis: Einige Inhalte wurden maschinell übersetzt.