Die vielen Funktionen des Bildungsportals der cogniport können Sie auch für Ihre Anwendungen (außerhalb des Portals) nutzen. Als Unternehmensadministrator finden Sie die Funktion API zur Verwaltung aller Zugriffspunkte (API-Endpunkt) im Menü unterhalb der Administration:
Übersicht aller Endpunkte #
Sie finden nun eine Übersicht aller bisher freigeschalteten API-Endpunkte. Sie können weiterhin sehen, wie viele Einheiten produziert wurden (siehe Kosten) und wie viele Zugriffe auf diesen Endpunkt erfolgten:
Erstellung eines neuen Endpunktes #
Um einen neuen Endpunkt zu erstellen, klicken Sie auf die Plus Schaltfläche in der Übersicht:
Sie sehen nun im Dropdown alle verfügbaren API-Endpunkte. Wählen Sie den Endpunkt aus, den Sie freischalten (und nutzen) möchten. Klicken Sie anschließend auf speichern:
Sie gelangen nun in die Ansicht des API-Endpunkts:
API-Endpunkt anzeigen #
Um einen API-Endpunkt anzuzeigen klicken Sie in der Übersicht auf dessen Namen:
Sie sehen nun in der Leiste ein paar wenige Statistiken, wie oft auf diesen Endpunkt zugegriffen worden ist und wer diesen Endpunkt erstellt hat. Darunter erhalten Sie nun detaillierte Informationen, wie Sie diesen Endpunkt nutzen können. Die meisten Endpunkte werden via POST angesprochen. Hierfür muss die aktuelle application_version als Feld angegeben werden. Diese Version oder auch Token genannt, erhalten Sie aus dem API Endpunkt token. Weitere Felder variieren je nach Endpunkt. Auch die Rückgabe ist hier beschrieben, sodass Sie Ihre Anwendung entsprechend auf das Resultat als JSON vorbereiten können:
Endpunkt löschen #
Einen Endpunkt können Sie direkt in der Übersicht löschen. Klicken Sie hierzu einfach auf das Löschen Symbol. Ein Zugriff auf den Endpunkt ist nun nicht mehr möglich:
Bitte beachten Sie, dass ein Endpunkt einen eindeutigen api_token erhält. Wenn Sie einen Endpunkt löschen und wieder neu anlegen erhält dieser einen neuen Token auch wenn der Endpunkt gleich ist!
API-Endpunkte #
- api/courses_upcoming: Liefert alle anstehenden Schulungen zurück, die im Bildungsportal angelegt wurden
- api/geocoordinates: Ermittelt die Geo-Koordinaten auf Basis einer Adresse und einer Stadt
- api/logo_get: Liefert das Logo einer Webseite als base64 zurück
- api/ocr: Liefert den Text eines JPG-Dokuments zurück
- api/qr_get: Erstellt einen QR-Code auf Basis eines gelieferten Texts und liefert einen base64 zurück
- api/rooms: Liefert alle Räume und deren Informationen zurück, die im Bildungsportal angelegt wurden
- api/text2speech: Erstellt einen gesprochenen Text des gelieferten Texts und liefert diesen als base64 zurück
- api/token: Liefert den aktuellen Token zurück, der zur Nutzung der POST-Services mitgeliefert werden muss
- api/translate: Übersetzt einen gelieferten Text in eine andere Sprache
- api/weather: Liefert Informationen zum aktuellen Wetter für einen gegebenen Ort zurück
