API-Konfiguration
Voraussetzungen
checkITeasy stellt seine Daten über eine REST-Schnittstelle bereit. Damit ein Fremdsystem sie nutzen darf, braucht es einen Schlüssel. Auf dieser Seite entstehen die administrativen Schlüssel des Mandanten. Die persönlichen Keys erzeugt sich dagegen jeder Benutzer selbst auf seiner Kontoseite.
Öffnen Sie in der Sidebar ganz unten „Administration".
Wählen Sie links „Konfiguration" und klicken Sie in der zweiten Spalte auf „API".
1 „API" in der zweiten Spalte · 2 „Hinzufügen" öffnet den Dialog für einen neuen Key. Die Seite hat drei Abschnitte: die Schnittstellenadresse, die Liste der Keys und die Downloads der Dokumentation. Klicken Sie unter „API-Keys" auf „Hinzufügen". Der Dialog „Neuer API-Key" öffnet sich.
Geben Sie eine Bezeichnung ein, an der Sie später erkennen, welches System diesen Key nutzt. Ohne Bezeichnung bleibt „OK" gesperrt.
Der Dialog verlangt nur eine Bezeichnung. Erst nach „OK" erscheint darunter zusätzlich das Feld „Key" mit dem erzeugten Schlüssel. Klicken Sie auf „OK". Der Dialog bleibt offen und zeigt zusätzlich das Feld „Key" mit dem erzeugten Schlüssel.
Kopieren Sie den Schlüssel über die Schaltfläche daneben und hinterlegen Sie ihn sofort dort, wo er gebraucht wird. Am besten in einem Passwortmanager, nicht in einer Notiz oder E-Mail.
Klicken Sie auf „Schließen". Der neue Key erscheint in der Liste.
Die Spalten der Liste
| Feld | Bedeutung |
|---|---|
| Bezeichnung | Der beim Anlegen vergebene Name. |
| Gültig von | Der Tag der Erstellung. |
| Gültig bis | Ein Jahr nach der Erstellung. Danach wird der Key abgelehnt und muss ersetzt werden. |
| Zugriffe | Wie oft der Key bisher verwendet wurde. |
| Letzter Zugriff | Wann zuletzt etwas mit diesem Key geschah. Daran erkennen Sie am schnellsten, ob ein Key ungenutzt ist. |
Die Karte „API"
| Feld | Bedeutung |
|---|---|
| API Url | Die Adresse, unter der die Schnittstelle dieses Mandanten erreichbar ist. Der Wert ist schreibgeschützt und stammt aus der Einrichtung. |
Einen Key widerrufen
Klicken Sie in der Liste am rechten Rand der betreffenden Zeile auf das Papierkorbsymbol.
1 Papierkorbsymbol am rechten Rand der Zeile. Die Spalte „Letzter Zugriff" verrät, ob ein Key überhaupt noch benutzt wird. Darunter liegen die beiden Downloads der API-Dokumentation. Bestätigen Sie die Rückfrage „API-Key löschen". Sie nennt die Bezeichnung des betroffenen Keys.
Die API-Dokumentation herunterladen
Unterhalb der Key-Liste steht die Dokumentation der Schnittstelle bereit. Sie wird aus dem tatsächlichen Stand dieses Mandanten erzeugt, nicht aus einem allgemeinen Handbuch. Das ist die Unterlage, die ein Entwickler braucht.
Klicken Sie auf „Dokumentation (PDF)", um die vollständige Beschreibung als PDF zu laden.
Klicken Sie auf „Postman-Collection", um eine Sammlung fertiger Anfragen zum direkten Ausprobieren zu laden.
Warten Sie den Download ab. Das Erzeugen dauert einen Moment. Solange sind beide Schaltflächen gesperrt.