Authentifizierung

Die Joinpoints REST API verwendet eine tokenbasierte Authentifizierung. Du erzeugst in deinem Joinpoints Account zuerst einen API Key. Mit diesem API Key beantragst du anschließend einen Access Token. Der Access Token wird bei jedem API-Request als Bearer Token mitgeschickt.

1) API Key erstellen

1. Öffne in Joinpoints deine Account-Einstellungen
2. Wechsle zu Apps
3. Erstelle eine neue App oder öffne eine bestehende
4. Erzeuge einen API Key

2) Access Token anfordern

Der Access Token wird über den Auth-Endpoint erstellt. Der genaue Request/Response ist in der Swagger-Dokumentation (siehe „API commands“) beschrieben.

Option 1: Authorization Header

Bei allen weiteren Requests sendest du den Token im Header:

Authorization: Bearer <ACCESS_TOKEN>

Option 2: Authorization Parameter

Bei allen weiteren Requests sendest du den Token als Parameter mit:

access_token = <ACCESS_TOKEN>

3) Typischer Ablauf in Integrationen

• Server-to-Server: Token bei Start holen und sicher im Backend cachen (Rotation/Erneuerung gemäß Token-Antwort)
• Automationen/Skripte: Token holen → Request ausführen → sauber loggen (Statuscodes/Responses)
• Fehlerfall: Bei 401/403 Token prüfen/erneuern und Berechtigungen kontrollieren

Statuscodes (allgemein)

• 200/201 – erfolgreich
• 400 – ungültiger Request (z. B. Feldtyp passt nicht)
• 401/403 – Token ungültig / keine Berechtigung
• 404 – Ressource nicht gefunden
• 500 – unerwarteter Serverfehler