API-Explorer
Der Rest API Explorer von CCW ist ein interaktives Tool, mit dem Benutzer CCW-APIs testen und erkunden können.
Der Rest API Explorer von CCW ist ein interaktives Tool, mit dem Benutzer die CCW-API auf folgende Weise testen und erkunden können:
- Durchsuchen SIE verfügbare REST-API-Ressourcen und Endpunkte
- Erfahren Sie mehr über die Methoden, die für jede API verfügbar sind, zusammen mit unterstützten Parametern und Inline-Dokumentation
- Experimentieren Sie, indem Sie Beispielanfragen für jeden verfügbaren API-Endpunkt einreichen, und sehen Sie die Antworten in Echtzeit
- Führen Sie authentifizierte und autorisierte API-Aufrufe über ein intuitives Framework durch, das keinen technischen Hintergrund erfordert
Um den API-Explorer zu verwenden, muss der Zugriff auf die Rest API von CCW zuerst vom CCW-Support angefordert werden. Bitte lesen Sie die Dokumentation zur CCW-API-Übersicht, um mehr darüber zu erfahren, wie Sie auf die API zugreifen und sie verwenden.
Zugriff auf den Explorer
Um zu beginnen, navigieren Sie zu: Integrations-Toolkit > Integrationsdokumentation . Klicken Sie auf REST API Explorer.
Spezifischer Zugriff auf den Explorer kann jedem CCW-Benutzer und/oder jeder Rolle gewährt werden, indem das Recht, Integration Toolkit > Integration Documentation, zugewiesen wird.
Die aktuell verfügbaren APIs werden angezeigt:
- Suche nach Kandidaten (/api/candidates/search)
- Kandidat bestätigen (/api/candidates/{id}/confirm)
- Contingent Worker Lookup (/api/contingent_workers)
Die Basis-URL, die zum Einreichen von API-Anfragen verwendet wird, stellt Ihre aktuelle CCW-Testumgebung dar.
Wenn CCW weitere APIs hinzufügt, können Sie in der Filter by Tag-Leiste eine bestimmte API finden, indem Sie Schlüsselwörter eingeben, die mit den Abschnittsüberschriften übereinstimmen.
Testen von APIs
Klicken Sie auf die API, die Sie testen möchten, und ein Formular wird erweitert, das die Namen und Beschreibungen der verfügbaren Parameter anzeigt:
Bestimmte Parameter umfassen einen Beispielwert (standardmäßig angezeigt) und ein Modell (klicken Sie hier, um die Eigenschaften der einzelnen Felder anzuzeigen).
Der Abschnitt Antworten enthält Codenummern (mit Beschreibungen), die in API-Antworten von CCW enthalten sein könnten.
Klicken Sie auf Ausprobieren, um eine Beispielanfrage im Explorer-Formular manuell zu bearbeiten.
Für die korrekte Formatierung und andere Anforderungen von CCW-API-Anfragen lesen Sie bitte die Dokumentation der einzelnen APIs:
- Kandidaten-Such-API
- Kandidaten-API bestätigen
- Such-API für Beschäftigte mit Zeitvertrag
Die X-Korrelations-ID, ein Pflichtfeld, wird automatisch generiert, wenn auf Ausprobieren geklickt wird.
Autorisierung, ebenfalls obligatorisch, erfordert ein Zugriffstoken, das außerhalb des Explorers generiert werden muss. Nach der Generierung dauert das Zugriffstoken 1 Stunde.
Eine Anwendung wie Postman kann verwendet werden, um das Zugriffstoken zu generieren und in das Autorisierungsfeld zu kopieren. Geben Sie in Postman die API-Zugangsdaten ein, die Ihnen von Coupa zur Verfügung gestellt wurden, einschließlich der Zugriffs-Token-URL, des Geheimnisses und des Umfangs.
Klicken Sie auf Ausführen, um Ihre Anfrage mit den von Ihnen eingegebenen zusätzlichen Parametern an die Basis-URL zu senden. Klicken Sie auf „Abbrechen“, um die Änderungen zu verwerfen.
Nach der Ausführung enthält der Antwortabschnitt den Antworttext, Kopfzeilen (und Fehler, falls zutreffend), die als Antwort auf Ihre API-Anfrage gesendet wurden. Bitte lesen Sie die oben verlinkte Dokumentation für weitere Details.