Ein Endpoint ist eine spezifische URL einer API, die einer bestimmten Ressource oder Aktion entspricht. Er ist der "Eintrittspunkt", über den Ihre Anwendung mit dem Server kommuniziert.
Was ist ein Endpoint?
Ein Endpoint (Endpunkt) ist eine spezifische URL, die von einer API bereitgestellt wird und eine Ressource oder Aktion repräsentiert. Jeder Endpoint kombiniert eine URL und eine HTTP-Methode, um genau zu definieren, was Sie tun können.
Struktur eines Endpoints
Ein Endpoint besteht aus:
- Basis-URL:
https://ailabsaudit.com/api/v1 - Ressourcenpfad:
/clients,/audits/42/results - HTTP-Methode: GET, POST, PUT, DELETE
- Parameter: Query String (
?page=1) oder Pfad (/clients/{id})
Gängige Beispiele
GET /api/v1/clients— Kunden auflistenGET /api/v1/clients/42— Details von Kunde #42POST /api/v1/audits/launch— Ein Audit startenGET /api/v1/reports/15/download— Einen Bericht herunterladen
AILabsAudit-Endpoints
Die REST-API von AILabsAudit bietet über 30 Endpoints, organisiert in 8 Gruppen: Kunden, Audits, Berichte, Aktionspläne, Fragebögen, Analytics, Modelle und Konto. Die vollständige Dokumentation ist über Swagger verfügbar.