Zum Hauptinhalt springen

Schnellstart Cannanas API

Die Cannanas API befindet sich aktuell in der Preview. Sie richtet sich an Teams, die Cannanas-Daten oder produktnahe Abläufe in eigene Systeme integrieren möchten. Welche Endpunkte und Felder aktuell verfügbar sind, entnimmst Du immer der aktuellen OpenAPI-Spezifikation.

Preview

Aktuell befindet sich die API in der Preview. Um Zugriff zu erhalten kontaktiere den Support.

-> Cannanas OpenAPI Specification​

✨ Was Du aktuell erwarten kannst​

  • Technische Integration – Nutze produktnahe Endpunkte für Dashboards, Backoffice-Systeme oder eigene Automationen.
  • Persönliche API-Keys – Der Zugriff erfolgt über API-Keys, die an einen konkreten Nutzeraccount gebunden sind.
  • OpenAPI als Quelle – Die Spezifikation ist die verlässliche Quelle für verfügbare Routen, Parameter und Antwortformate.

🚀 Schnellstart​

1. API-Key erstellen​
  • Öffne Dein Profil und gehe zum Bereich API Keys.
  • Erzeuge einen persönlichen API-Key und kopiere ihn.
  • Verwende den Key im Request-Header:
Authorization: Bearer <your-api-key>
Wichtig

API-Keys sind immer an Deinen Nutzer Account gebunden. Gebe Deinen API-Key niemals weiter oder veröffentliche ihn. Er ermöglicht den Zugriff auf Deine Vereinsdaten.

2. Direkt im Browser testen​
  • Klicke unten auf Authorize und füge Deinen API-Key ein.
  • Teste die Authentifizierung mit dem Authentication Test Endpoint.
  • Klicke Try it out → Execute.
  • Eine erfolgreiche Antwort sieht so aus:
{ "message": "Authentication successful" }
3. Mit curl testen​
curl https://api.cannanas.club/v1/auth/test --header 'Authorization: Bearer <your-api-key>'

🔎 Hinweise zur Preview​

  • Prüfe vor einer produktiven Integration immer die aktuelle OpenAPI-Spezifikation.
  • Rechne damit, dass sich einzelne Endpunkte oder Felder während der Preview noch ändern können.
  • Wenn Du eine konkrete Integration planst, kläre den empfohlenen API-Umfang am besten vorab mit dem Support.

💬 Support​

  • Website: Cannanas Support
  • Sprachen: Deutsch & Englisch
  • Tipp: Nutze die Cannanas OpenAPI Specification, um Client-Bibliotheken in Deiner bevorzugten Programmiersprache zu generieren oder sie an Dein bevorzugtes LLM zu übergeben.

Siehe auch​