Zum Hauptinhalt springen

Public API – Überblick und Schnellstart

Was die Public API kann, welche Basis-URL du nutzt und wie dein erster Request in wenigen Minuten läuft.

Verfasst von Support Team

Mit der Public API verbindest du RIP App Business mit deiner Warenwirtschaft, deinem ERP, mit Make, Zapier oder eigenen Skripten. Du legst Trauerfälle an und pflegst sie, verwaltest Termine und Dokumente, verbindest RIP Tags und holst den Link für Angehörige ab. Umgekehrt meldet dir RIP App Business per Webhook, wenn ein Trauerfall einen bestimmten Prozessschritt erreicht.

Die API arbeitet mit JSON über HTTPS und einem persönlichen API-Key.

Was du brauchst

  1. Das Modul Public API. Du buchst es im Shop. Für Bestellungen im Shop müssen Firmenadresse und SEPA-Lastschrift hinterlegt sein.

  2. Einen API-Key. Unter Einstellungen → Public API klickst du auf API-Key erzeugen. Details: Authentifizierung und API-Keys.

  3. Die Basis-URL deiner Region (siehe unten).

Basis-URL

Jede Region hat ihre eigene Adresse. Der Pfad ist überall gleich.

Region

Basis-URL

Deutschland

https://de.rip-app.business/api/public/v1

Niederlande

https://nl.rip-app.business/api/public/v1

Dein API-Key und deine Daten gehören immer zu genau einer Region. Ein Key aus Deutschland funktioniert nicht in den Niederlanden. Welche Region deine ist, siehst du in der Adresszeile, wenn du im Web angemeldet bist.

Alle Beispiele in dieser Dokumentation nutzen die deutsche Region und das fiktive Unternehmen Bestattungen Berger mit dem Trauerfall Gisela Neumann.

Schnellstart

1. API-Key bereitlegen

Lege den Key als Umgebungsvariable ab, damit er nicht in deinem Code oder deiner Shell-Historie landet:

export RIP_API_KEY="rip_pub_…"   # dein API-Key aus Einstellungen → Public API

2. Verbindung prüfen

curl https://de.rip-app.business/api/public/v1/me \
  -H "Authorization: Bearer $RIP_API_KEY"
{
  "success": true,
  "data": {
    "user_id": 14,
    "email": "[email protected]",
    "first_name": "Jonas",
    "last_name": "Berger",
    "role": "owner",
    "organization_id": 7,
    "token_id": 31
  }
}

Bekommst du 401 oder 403, hilft dir Fehler und Rate-Limits weiter.

3. Bestattungsarten abrufen

Beim Anlegen eines Trauerfalls brauchst du die ID der Bestattungsart:

curl https://de.rip-app.business/api/public/v1/burial-types \
  -H "Authorization: Bearer $RIP_API_KEY"
{
  "success": true,
  "data": [
    { "id": 5, "uuid": "0b6f2d1e-8c3a-4e5b-9f7d-2a1c4e6b8d90", "name": "Erdbestattung", "color_primary": "#1e3a5f", "color_secondary": "#c9a84c", "steps_count": 4, "cases_count": 23 },
    { "id": 6, "uuid": "5c2e9a7b-1d4f-4b8e-a6c3-7f0d2e9b4a18", "name": "Feuerbestattung", "color_primary": "#6b2737", "color_secondary": "#c4a0a0", "steps_count": 5, "cases_count": 41 }
  ]
}

4. Ersten Trauerfall anlegen

curl -X POST https://de.rip-app.business/api/public/v1/cases \
  -H "Authorization: Bearer $RIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "Gisela",
    "last_name": "Neumann",
    "date_of_birth": "1938-04-02",
    "date_of_death": "2026-11-10",
    "burial_type_id": 6
  }'

Die Antwort hat den Status 201 Created und enthält den vollständigen Trauerfall. Für alle weiteren Aufrufe merkst du dir die uuid:

{
  "success": true,
  "data": {
    "id": 1287,
    "uuid": "3f8c2a91-6d4e-4b7a-9c15-8e2f0b6d1a47",
    "deceased_name": "Gisela Neumann",
    "burial_type_name": "Feuerbestattung",
    "status": "active",
    "customer_link_url": "https://de.rip-app.business/t/3f8c2a91-6d4e-4b7a-9c15-8e2f0b6d1a47"
  }
}

Die Antwort ist hier gekürzt. Alle Felder findest du unter Trauerfälle.

5. Link für Angehörige weitergeben

customer_link_url ist der Link, den Angehörige ohne Anmeldung öffnen. Mehr dazu: RIP Tag und Link für Angehörige.

Testfälle aufräumen: Trauerfälle lassen sich über die API nicht löschen. Archiviere Testfälle nach dem Ausprobieren mit POST /cases/{uuid}/archive – siehe Prozess, Pause und Abschluss.

Alle Endpunkte

Alle Pfade gelten relativ zur Basis-URL, zum Beispiel https://de.rip-app.business/api/public/v1/cases.

Methode

Pfad

Zweck

Artikel

GET

/me

Key und Benutzer prüfen

GET

/burial-types

Bestattungsarten

GET

/branches

Standorte (Filialen)

GET

/users

Mitarbeiter

GET

/document-tags

Dokument-Tags

GET

/cases

Trauerfälle auflisten

POST

/cases

Trauerfall anlegen

GET

/cases/{uuid}

Trauerfall abrufen

PATCH

/cases/{uuid}

Trauerfall ändern, pausieren, fortsetzen

POST

/cases/{uuid}/step

Prozessschritt setzen

POST

/cases/{uuid}/archive

Archivieren

POST

/cases/{uuid}/complete

Abschließen

GET

/cases/{uuid}/dates

Termine auflisten

POST

/cases/{uuid}/dates

Termin anlegen

PATCH

/dates/{uuid}

Termin ändern

DELETE

/dates/{uuid}

Termin löschen

GET

/cases/{uuid}/documents

Dokumente auflisten

POST

/cases/{uuid}/documents

Dokument hochladen

GET

/documents/{uuid}/download

Dokument herunterladen

DELETE

/documents/{uuid}

Dokument löschen

POST

/cases/{uuid}/tag

RIP Tag per Startcode verbinden

Webhooks richtest du in der Oberfläche ein, nicht über die API: Webhooks.

Weiterlesen

Hat dies deine Frage beantwortet?