Verbinde campai mit deinen Systemen.

Lies und bearbeite Daten über die REST-API. Reagiere mit Webhooks auf Änderungen und behalte deine Anbindung mit den API- und Zustellprotokollen im Blick.

Erste Anfrage starten API-Referenz ansehen

GET/apiKey/info

curl --request GET \
  'https://cloud.campai.com/api/apiKey/info' \
  --header 'X-API-Key: YOUR_API_KEY'

const response = await fetch(
  'https://cloud.campai.com/api/apiKey/info',
  { headers: { 'X-API-Key': process.env.CAMPAI_API_KEY } }
);
if (!response.ok) throw new Error(String(response.status));
const { organization, permissions } = await response.json();

Organisation und Berechtigungen abrufen

Führe die Anfrage auf deinem Server aus. Dein API-Schlüssel gehört nicht in öffentlich zugänglichen Browser-Code.

Endpunkt und Antwort ansehen

Zugriffe gezielt vergeben

Bestimme pro Schlüssel, welche Daten deine Anbindung lesen und bearbeiten darf.

Änderungen weitergeben

Nutze signierte Webhooks mit automatischen Wiederholungen bei Zustellfehlern.

Fehler nachvollziehen

Prüfe Anfragen, Antworten, HTTP-Status und Laufzeiten in den Protokollen.

Was du mit der API aufbauen kannst

Wähle den passenden Einstieg für deine eigene Anbindung. Die Referenz zeigt dir die verfügbaren Endpunkte und Datenformate.

Kontakte abgleichen

Rufe Kontakte ab, lege neue Datensätze an oder aktualisiere vorhandene. Baue darauf den Abgleich mit deinem eigenen System auf.

Zur Kontakt-API

Buchungen weiterverarbeiten

Greife auf Buchungsdaten zu. Mit Webhooks kann dein System auf ausgewählte erstellte, geänderte oder gelöschte Buchungen reagieren.

Zur Buchungs-API

Dateien per API hochladen

Fordere eine Upload-URL an, lade deine Datei hoch und verwende ihre Referenz in einem Endpunkt, der Dateien unterstützt.

Zur Datei-Anleitung

Gib deiner Anbindung genau die passenden Rechte.

Erstelle einen benannten API-Schlüssel für deine Organisation. Lege fest, welche Bereiche er lesen, anlegen, ändern oder löschen darf, und grenze den Datenzugriff ein.

Zugänge verwalten

Passe die Einstellungen deiner Schlüssel an und widerrufe Zugänge, die du nicht mehr benötigst.

Anfragen gezielt untersuchen

Filtere API-Protokolle nach Methode, Status oder Zeitraum. Vergleiche in den Details die Anfrage mit ihrer Antwort.

Erstellung eines API-Schlüssels mit Beschreibung und ausgewählten Leserechten für Mitglieder und Adressen

Eine Änderung in campai. Dein System reagiert.

Wähle ein Ereignis und die Ziel-URL deiner Anwendung. campai übermittelt die Nachricht; dein Code prüft sie und verarbeitet die Änderung.

Ereignis in campai
Zum Beispiel: eine Buchung wird erstellt.
Signierter Webhook
Die Nachricht geht an deine Ziel-URL.
Deine Anwendung
Dein Code verarbeitet die Änderung.

Webhook-Einstellungen mit auswählbaren Ereignissen für erstellte, geänderte und gelöschte Buchungen

Signatur prüfen

Prüfe eingehende Inhalte mit dem Signaturschlüssel deines Webhooks. campai verwendet HMAC-SHA512.

Zustellversuche verfolgen

Bei Zustellfehlern versucht campai den Versand mit wachsendem Abstand erneut. Im Protokoll siehst du jeden Versuch und seine Antwort.

Nach Fehlern fortsetzen

Erkenne dauerhaft fehlgeschlagene Webhooks am Status und aktiviere sie nach der Fehlerbehebung wieder.

Von deinem Schlüssel zur ersten Antwort

Teste zunächst deinen API-Zugang. Für diesen Endpunkt brauchst du noch keine Organisations-ID.

Schlüssel erstellen
Öffne in deiner Organisation „API & Developer“, wähle die benötigten Rechte und speichere den Schlüssel sicher. Er wird nur einmal angezeigt.
Anfrage senden
Setze deinen Schlüssel im Header X-API-Key und rufe GET /apiKey/info auf. Nutze dafür das Codebeispiel oben.
Antwort prüfen
Die Antwort enthält organization und permissions. Verwende die Organisations-ID für weitere Endpunkte, die sie benötigen.

200Antwortstruktur bei erfolgreicher Anfrage

organization: Die ID der Organisation, zu der dein Schlüssel gehört.
permissions: Die für diesen Schlüssel vergebenen Berechtigungen.

401Authentifizierung fehlt

Prüfe, ob deine Anfrage den Header X-API-Key mit einem gültigen Schlüssel enthält.

403Berechtigung fehlt

Prüfe die Rechte und Dateneinschränkungen des Schlüssels für den angefragten Bereich.

API-Dokumentation

Finde verfügbare Endpunkte, Anfrage- und Antwortformate sowie Beispiele für deine Anbindung. Die Dokumentation ist auf Englisch verfügbar.

Zur API-Dokumentation

Mit der ersten Anfrage starten

Erstelle einen API-Schlüssel, richte die Authentifizierung ein und prüfe deine erste Anfrage.

Zur Einstiegsanleitung

Fragen zu deiner Anbindung

Brauche ich für jede Organisation einen eigenen Schlüssel?

Ja. Ein API-Schlüssel ist einer Organisation zugeordnet. Wenn du mehrere Organisationen anbindest, benötigst du für jede einen eigenen Schlüssel.

Wann nutze ich die API, wann einen Webhook?

Über die REST-API fragt dein Code Daten ab oder ändert sie. Ein Webhook informiert deine Anwendung, wenn ein ausgewähltes Ereignis in campai eintritt. Beide Wege können sich in deiner Anbindung ergänzen.

Kann ich einen Client für meine Programmiersprache erzeugen?

Die öffentliche OpenAPI-Spezifikation beschreibt die Schnittstelle und kann als Grundlage für einen generierten Client dienen. Prüfe den erzeugten Code für die Endpunkte, die deine Anwendung nutzt.

OpenAPI-Spezifikation öffnen

Gibt es auch fertige Integrationen?

Ja. Die erweiterten Funktionen enthalten einen Katalog vorhandener Integrationen. Prüfe dort, ob die passende Verbindung für deinen Ablauf bereits verfügbar ist.

Vorhandene Integrationen ansehen