Der neue API-Explorer

07.11.2016

API

Seit bereits 8 Jahren bieten wir unseren Kunden den Service an, unsere Dienstleistungen über eine API einfach in ihre IT-Infrastruktur und Unternehmensabläufe zu integrieren. Über die API können unsere Kunden u. a. neue Aufträge erstellen, Auftragsdaten übermitteln und Ergebnisse direkt in ihr System einfließen lassen. Dieser Service wird von unseren Kunden gerne und zunehmend genutzt. Jetzt haben wir die API für unsere Kunden weiter optimiert.

Der neue API-Explorer

Als Dokumentation für die Benutzung und Integration der API standen bisher zwei PDF-Dokumente zur Verfügung (Concepts und Reference). Seit heute gibt es auf unserer Sandbox-Umgebung eine interaktive Oberfläche, um die einzelnen API-Endpoints auszuprobieren.
Dies veranschaulicht, welche Header zu setzen sind und wie eine entsprechende Response aussieht. Darüber hinaus werden für jeden Request Beispiel-curl-Befehle generiert, mit denen die API auf dem eigenen Computer getestet werden kann. Dies vereinfacht das Einbinden unserer API in das Kundensystem, da während der Entwicklung die einzelnen Aufrufe besser getestet werden können.

Benutzung:

  1. Die API-Explorer-Seite öffnen: https://sandbox.clickworker.com/api_doc
  2. Oben rechts auf „Authorize“ klicken und sich mit seinen API-Credentials anmeldenAPI
  3. Einen der Endpoints auswählen, zum Beispiel POST task_templates
  4. Unter „Parameters“ einmal in das „Example Feld“ klicken (siehe Screenshot).API
    Nun werden die Beispieldaten als Parameter übernommen und können noch bearbeitet werden
  5. Den Request abschicken „Try it out“ und Ergebnisse ansehen

 

Wir hoffen der neue Explorer gefällt Ihnen. Wenn Sie noch weitere Fragen zu unserer API haben, freut sich unser technisches Support-Team über eine E-Mail von Ihnen an info@clickworker.com.

 

Dieser Artikel wurde am 07.November 2016 von Nils geschrieben.

von: Nils L.

Nils L., Softwareentlickler