API-Schnellstart

Deine erste API-Anfrage

campflow stellt eine REST-API über HTTPS bereit, über die du mit externen Tools auf einige Funktionen und Daten in deinem Account zugreifen kannst.

Die API steht für deinen Workspace auf Anfrage ohne Mehrkosten zur Verfügung. Bei Interesse kontaktiere uns gerne unter support@campflow.de.

Alle API-Endpunkte sind unter dieser Base URL erreichbar:

https://api.campflow.de/

Für sämtliche Endpunkte ist Authentifizierung über einen API Token erforderlich.

Content-Type
Sofern ein Endpunkt JSON-Daten im Request Body erwartet, sollte der Content-Type Header mit dem Wert application/json übergeben werden.
Authorization
Im Authorization Header sollte ein gültiger API Token als Bearer Token übergeben werden. Weitere Informationen unter Authentifizierung.

Bei GET-Endpunkten werden Parameter in Form eines Query Strings übergeben.

Bei allen weiteren Endpunkten werden, falls erforderlich, die Eingabedaten in Form eines JSON-formatierten Request Bodys erwartet.

Alle Endpunkte geben entweder eine leere Response (Statuscode 204) oder eine Response im JSON-Format zurück.

Die eigentlichen Nutzdaten befinden sich hierbei im Schlüssel data.

Unter meta sind ggf. Informationen zur Pagination enthalten. Dieser Schlüssel ist jedoch nicht bei allen Endpunkten vorhanden.

{
    "data": {},
    "meta": {}
}

Eine Integration sollte in der Lage sein, alle hier dokumentierten HTTP Statuscodes zu behandeln.