API-Explorer

Der REST-API-Explorer von CCW ist ein interaktives Tool, mit dem Benutzer die CCW-API auf folgende Weise testen und erkunden können:

• Verfügbare REST-API-Ressourcen und Endpunkte durchsuchen
• Erfahren Sie mehr über die für jede API verfügbaren Methoden sowie die unterstützten Parameter und die Inline-Dokumentation
• Experimentieren Sie, indem Sie Beispielanforderungen für alle verfügbaren API-Endpunkte einreichen und Antworten in Echtzeit anzeigen
• Authentifizierte und autorisierte API-Aufrufe über ein intuitives Framework ohne technischen Hintergrund

Um den API-Explorer zu verwenden, muss der Zugriff auf die REST-API von CCW zuerst vom CCW-Support angefordert werden. Bitte überprüfen Sie CCW API - Übersicht Dokumentation um mehr über den Zugriff auf die API und ihre Verwendung zu erfahren.

Auf den Explorer zugreifen

Navigieren Sie zu Beginn zu: Integrations-Toolkit > Integrationsdokumentation , Klicken REST-API-Explorer.

Die derzeit verfügbaren APIs werden angezeigt:

• Kandidatensuche (/api/categories/search)
• Kandidatenbestätigung (/api/kandidaten/{id}/confirm)
• Contingent Worker-Suche (/api/contingent_workers)

Die Basis-URL , das für die Übermittlung von API-Anforderungen verwendet wird, stellt Ihre aktuelle CCW-Testumgebung dar.

Wenn CCW weitere APIs hinzufügt, Nach Tag filtern -Leiste können Sie eine bestimmte API finden, indem Sie Schlüsselwörter eingeben, die mit Abschnittsüberschriften übereinstimmen.

Testen von APIs

Klicken Sie auf die API, die Sie testen möchten, und ein erweitertes Formular zeigt die Namen und Beschreibungen der verfügbaren Parameter:

Zu bestimmten Parametern gehört ein Beispielwert (standardmäßig angezeigt) und Modell (klicken, um die Eigenschaften der aufgelisteten Felder anzuzeigen).

Die Antworten Abschnitt enthält Codenummern (mit Beschreibungen), die in API-Antworten von CCW enthalten sein könnten.

Klicken Probieren Sie es aus , um eine Beispielanforderung im Explorer-Formular manuell zu bearbeiten.

Für die richtige Formatierung und andere Anforderungen von CCW-API-Anforderungen lesen Sie bitte die Dokumentation jeder spezifischen API:

• API zur Kandidatensuche
• Kandidatenbestätigungs-API
• Contingent Worker-Lookup-API

X-Korrelations-ID, ein Pflichtfeld, wird automatisch generiert, wenn Probieren Sie es aus wird geklickt.

Autorisierung, auch obligatorisch, erfordert ein Zugriffstoken, das außerhalb des Explorers generiert werden muss. Nach der Generierung dauert das Zugriffstoken 1 Stunde.

Klicken Ausführen um Ihre Anfrage an die Basis-URL mit den zusätzlichen Parametern zu übermitteln, die Sie eingegeben haben. Oder klicken Sie auf Brechen Sie den Vorgang ab um Ihre Änderungen zu verwerfen.

Nach der Ausführung Antwort enthält den Antworttext, Kopfzeilen (und ggf. Fehler), die als Antwort auf Ihre API-Anforderung gesendet werden. Bitte lesen Sie die oben verlinkte Dokumentation für weitere Details.