Zum Inhalt springen
Ordinus
Kostenlos registrieren

Dokumentation

Alles, was du brauchst, um die Terminplanung zu starten, anzupassen und zu integrieren.

Produktdokumentation

Anleitungen und Tutorials zur Nutzung von Ordinus. Erfahre, wie du dein Konto einrichtest, Termine verwaltest und mehr.

Hilfecenter öffnen

API-Dokumentation
Pro

Vollständige API-Referenz für Entwickler. Erstelle individuelle Integrationen und automatisiere deinen Planungsworkflow.

API-Referenz

Pro-Funktion

Die Ordinus API steht Nutzern mit Pro-Tarif zur Verfügung. Alle Endpunkte folgen REST-Prinzipien und geben JSON zurück.

Authentifizierung

API-Anfragen werden mithilfe von API-Schlüsseln authentifiziert. Generiere deinen API-Schlüssel auf der Entwicklerseite in deinem Konto.

curl https://api.ordinus.io/v1/appointments \
  -H "Authorization: Bearer YOUR_API_KEY"

Bewahre deine API-Schlüssel sicher auf und übertrage sie niemals in die Versionsverwaltung.

Übersicht der Endpunkte

GET
/v1/appointmentsTermine auflisten
GET
/v1/appointments/:idTermin abrufen
POST
/v1/appointmentsTermin erstellen
PATCH
/v1/appointments/:idTermin aktualisieren
DELETE
/v1/appointments/:idTermin stornieren
GET
/v1/availabilityVerfügbare Zeitfenster abrufen

Beispielanfrage

Erstelle einen neuen Termin mit der API:

curl -X POST https://api.ordinus.io/v1/appointments \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "appointment_type_id": "apt_123",
    "start_time": "2024-01-15T10:00:00Z",
    "client": {
      "name": "John Doe",
      "email": "john@example.com"
    }
  }'

Beispielantwort

{
  "id": "appt_abc123",
  "appointment_type_id": "apt_123",
  "start_time": "2024-01-15T10:00:00Z",
  "end_time": "2024-01-15T11:00:00Z",
  "status": "confirmed",
  "client": {
    "name": "John Doe",
    "email": "john@example.com"
  },
  "created_at": "2024-01-10T14:30:00Z"
}

Fehlerformat

Alle Fehler folgen einem einheitlichen Format:

{
  "error": {
    "code": "invalid_request",
    "message": "Missing required field: client.email",
    "param": "client.email"
  }
}

Häufige Fehlercodes: invalid_request, authentication_failed, rate_limit_exceeded, resource_not_found

Ratenlimits

API-Anfragen unterliegen einer Ratenbegrenzung, um die Verfügbarkeit des Dienstes für alle Nutzer sicherzustellen:

  • 100 Anfragen pro Minute und API-Schlüssel
  • 1.000 Anfragen pro Stunde und API-Schlüssel
  • Ratenlimit-Header sind in allen Antworten enthalten

Kontaktiere den Support, wenn du für deinen Anwendungsfall höhere Ratenlimits benötigst.

Webhooks

Mit Webhooks erhältst du Echtzeit-Benachrichtigungen für Ereignisse in deinem Konto. Konfiguriere Endpunkte auf der Entwicklerseite.

Verfügbare Ereignisse:

  • appointment.created - Neuer Termin gebucht
  • appointment.updated - Termin geändert
  • appointment.cancelled - Termin storniert
  • payment.succeeded - Zahlung abgeschlossen
  • payment.failed - Zahlung fehlgeschlagen

Webhook-Anfragen enthalten einen X-Ordinus-Signature Header zur Verifizierung. Überprüfe immer die Signaturen, bevor du Webhook-Daten verarbeitest.