CCW API-Übersicht
Die REST-API von CCW ermöglicht es Kunden und Partnern, neue Anwendungen zu entwickeln und auf neue Weise in CCW zu integrieren, um ihre Fähigkeiten zur Verwaltung einer Contingent Workforce zu verbessern.
Mit der REST-API von CCW können Kunden und Partner neue Anwendungen entwickeln und auf neue Weise in CCW integrieren, um ihre Fähigkeiten zur Verwaltung einer Contingent Workforce zu verbessern. CCW-APIs sind HTTP-basierte RESTful-APIs, die OAuth 2.0 für die Authentifizierung und TLS 1.2 für die Transportschichtsicherheit verwenden. Diese Dokumentation erklärt, wie Sie auf die API von CCW zugreifen und Anforderungen stellen, um die benötigten Daten zu erhalten.
Authentifizierung
Kunden, die auf die CCW REST-API zugreifen möchten, können API-Consumer-App registrieren und erhalten die OAuth 2.0-Client-Anmeldeinformationen, die in Kombination mit zwei zusätzlichen Sicherheitsebenen - Geltungsbereiche und Benutzer-/Rollenzugriffsrechte - zur Authentifizierung von Anforderungen an die CCW-API verwendet werden können.
| Authentifizierungsanforderung | Beschreibung |
|---|---|
| OAuth 2.0-Anmeldeinformationen | Enthält eine Kunden-ID und ein Kundengeheimnis |
| Geltungsbereiche | Die Endpunkte, die auf das spezifische Modul/die spezifische Funktionalität in CCW hinweisen, das/die angefordert wird |
| Benutzer-/Rollenzugriffsrechte | In der CCW-Anwendung zugewiesen. Sobald Sie von der API authentifiziert wurden (siehe unten), bestimmt eine andere Sicherheitsebene den Zugriff auf die spezifischen Funktionen, die angefordert werden |
Zugriffs-Token
Der erste Schritt beim Zugriff auf die CCW-API besteht darin, ein Zugriffstoken anzufordern, indem ein Aufruf mit den OAuth-Anmeldeinformationen und dem/den Gültigkeitsbereich(en) erfolgt, wie im folgenden Beispiel gezeigt:
curl -XPOST -H "Content-type: application/json" -d '{"client_id": "<<clientID>>", "client_secret": "<<secret>>",
"scope":"ccw.candidate", "grant_type":"client_credential"}' 'Auth_Url'
Verwenden Sie für "Auth_Url" je nach Umgebung Folgendes:
-
Sandbox:
https://sso-stg1.coupahost
com/as/token.oauth2 -
Produktion:
https://sso-prd1.coupahost
com/as/token.oauth
Der Autorisierungsserver gibt eine JSON-Payload zurück, die Folgendes enthält:
| Eigenschaft | Wert |
|---|---|
| token_type | Präfix mit "Träger" |
| access_token | Zeichenfolge, die in den Autorisierungskopf eingeschlossen werden soll, wenn API-Anforderungen gestellt werden |
| läuft ab_in | Anzahl der Sekunden, bis das Token abläuft (normalerweise 3600 oder 1 Stunde) |
API-Endpunkte
Schließen Sie das in Aufrufen von CCW-API-Endpunkten empfangene Zugriffstoken ein. Die Anforderung wurde validiert (oder gibt einen Fehler zurück - siehe Fehlercodes ).
Endpunktformat:
https://<instance>/api/<resource path>
Beispiele:
- Bestätigung des Kandidaten: https://
- Kandidatensuche: https://{hostname}/API/Kandidaten/Suche
- Contingent Worker (CW)-Suche: https://{hostname}/API/contingent_workers
Kopfzeilen anfordern
Die folgenden HTTP-Anforderungskopfzeilen sind erforderlich:
| Kopfzeile | Beschreibung |
|---|---|
| Autorisierung |
Wird verwendet, um Zugriff für API-Aufrufe anzufordern. Fügen Sie das Inhabertoken in das Authentifizierungsschema ein:
Inhaber: |
| Inhaltstyp | Einstellung: Anwendung/json in allen Anfragen. JSON ist das einzige derzeit unterstützte Austauschformat |
| X-Korrelations-ID | Eine Kennung mit maximal 36 Zeichen, die generiert wird, um die Verfolgung und Prüfung der API-Anforderung zu ermöglichen |
Fehlerantworten
Beispielfehlerantwort
{
"error_code": "string",
"error_summary": "string",
"error_causes": [
{
"error_sub_code": "string",
"error_sub_code_desc": "string"
}
]
}
Fehlercodes
Bitte lesen Sie die Fehlercodeabschnitte jeder spezifischen CCW-API:
- Kandidatensuch-API - Fehlercodes
- API zur Bestätigung von Kandidaten - Fehlercodes
- CW-Such-API - Fehlercodes
Satzbegrenzung
CCW REST-APIs haben keine explizite Ratenbegrenzung. Für eine rechtzeitige Antwort wird jedoch eine Drosselung von API-Anforderungen empfohlen. In Kürze werden die einzelnen API-Endpunkte mit der empfohlenen Preisbegrenzung aktualisiert.
Best Practices
Im Folgenden finden Sie einige Tipps, um die besten Ergebnisse sicherzustellen, wenn Sie Anwendungen auf CCW mit unseren REST-APIs erstellen:
- Schemavalidierung vermeiden: CCW-APIs entwickeln sich ständig weiter, wobei der API neue optionale Eigenschaften hinzugefügt werden. Aus Gründen der Erweiterbarkeit sollten Anwendungen keine Schemavalidierung durchführen, was Fehler auslösen kann, wenn die API neue Eigenschaften sendet, die möglicherweise nicht erforderlich sind.
- HTTP-Statuscodes verwenden: Verbraucheranwendungen sollten sich bei der Handhabung von API-Fehlern auf HTTP-Statuscodes verlassen, anstatt Inhalte des Antworttexts, die nur für Diagnose- und Protokollierungszwecke gedacht sind.
- Vermeiden je nach Reihenfolge der Eigenschaften in der API-Antwort: CCW-APIs unterstützen nur JSON-Inhalt. Die Reihenfolge der Eigenschaften in einer API-Antwort kann sich aufgrund der Einführung neuer Eigenschaften ändern.
Parts or all of this page might have been machine-translated. We apologize for any inaccuracies.