Zum Hauptinhalt springen

Public API – Authentifizierung und API-Keys

So erzeugst du einen API-Key, schickst ihn mit jedem Request und gehst sicher mit ihm um.

Verfasst von Support Team

Jeder Request an die Public API braucht einen API-Key. Der Key ist persönlich: Er gehört zu deinem Benutzer und arbeitet mit den Daten deines Unternehmens.

API-Key erzeugen

Voraussetzung: Das Modul Public API ist im Shop gebucht. Ohne Modul siehst du an dieser Stelle nur einen Hinweis.

  1. Öffne Einstellungen → Public API (Bereich Anwendung).

  2. Klicke auf API-Key erzeugen und bestätige mit Key erzeugen.

  3. Kopiere den Key mit Key kopieren und speichere ihn sicher, zum Beispiel in deinem Passwort-Manager.

  4. Schließe das Fenster mit Fertig.

Der Key wird nur einmal angezeigt. Danach siehst du in den Einstellungen nur noch seinen Anfang (zum Beispiel rip_pub_3a9f2c71…) und wann er zuletzt genutzt wurde.

Ein API-Key sieht so aus: rip_pub_ gefolgt von 48 Zeichen (0–9, a–f).

Key mitsenden

Schicke den Key im Authorization-Header als Bearer-Token:

Authorization: Bearer rip_pub_…
curl https://de.rip-app.business/api/public/v1/me \
  -H "Authorization: Bearer $RIP_API_KEY"
// Node.js 18+ (serverseitig)
const BASE_URL = "https://de.rip-app.business/api/public/v1";

const res = await fetch(`${BASE_URL}/me`, {
  headers: { Authorization: `Bearer ${process.env.RIP_API_KEY}` },
});
const body = await res.json();
if (!body.success) throw new Error(`${res.status}: ${body.error}`);
console.log(body.data.organization_id);

Achte auf die Schreibweise Bearer mit großem B und genau einem Leerzeichen danach. Andere Verfahren (Basic Auth, Key als URL-Parameter) gibt es nicht.

Key prüfen

GET /me

Gibt zurück, zu wem der Key gehört. Nutze den Endpunkt als Verbindungstest in deiner Integration.

Feld

Typ

Beschreibung

user_id

Integer

ID deines Benutzers

email

String

E-Mail-Adresse deines Benutzers

first_name

String

Vorname

last_name

String

Nachname

role

String

Deine Rolle im Unternehmen: owner, admin oder member

organization_id

Integer

ID deines Unternehmens

token_id

Integer

ID des verwendeten Keys

{
  "success": true,
  "data": {
    "user_id": 14,
    "email": "[email protected]",
    "first_name": "Jonas",
    "last_name": "Berger",
    "role": "owner",
    "organization_id": 7,
    "token_id": 31
  }
}

Rechte

  • Ein Key arbeitet in deinem Namen. Trauerfälle, die du über die API anlegst, haben dich als Ersteller (created_by). Hochgeladene Dokumente zeigen dich als Uploader, und im Protokoll des Falls erscheinst du.

  • Gleiche Rechte für alle Rollen. Über die Public API hat jeder Key Zugriff auf alle Trauerfälle, Termine und Dokumente des Unternehmens – egal ob Inhaber, Admin oder Mitglied. Es gibt keine eingeschränkten Keys.

  • Jedes Teammitglied kann einen eigenen Key erzeugen, sobald das Modul gebucht ist.

  • Nur Daten des eigenen Unternehmens. Eine UUID aus einem anderen Unternehmen führt zu 404.

Ein Key pro Benutzer

  • Pro Benutzer gibt es genau einen aktiven Key.

  • Erzeugst du über Neuen API-Key erzeugen einen neuen Key, wird der bisherige sofort ungültig. Stelle deine Integrationen direkt danach um.

  • Mit Widerrufen sperrst du deinen Key ohne Ersatz.

  • Keys laufen nicht von selbst ab.

  • Wird dein Benutzer aus dem Team entfernt oder löschst du dein Konto, wird der Key sofort mit gelöscht.

Wenn mehrere Systeme die API nutzen, ist ein eigener Benutzer für die Integration (zum Beispiel „Schnittstelle ERP“) übersichtlicher: Dann hängt die Integration nicht am Key einer Person, und im Protokoll ist erkennbar, was die Schnittstelle getan hat.

Wann ein Key nicht mehr funktioniert

Situation

Antwort

Header fehlt, Bearer fehlt oder der Key beginnt nicht mit rip_pub_

401 – Authorization required

Key ist unbekannt, wurde widerrufen oder durch einen neuen ersetzt, oder dein Benutzer wurde entfernt bzw. hat sein Konto gelöscht

401 – Invalid or expired token

Dein Benutzer gehört keinem Unternehmen mehr an

403 – Keine Organisation zugewiesen

Das Modul Public API ist nicht (mehr) gebucht

403 – Public API ist für diese Organisation nicht freigeschaltet

Zu viele fehlgeschlagene Anmeldeversuche von deiner IP-Adresse

429

Sicherheit

  • Der Key gibt Zugriff auf personenbezogene Daten Verstorbener und Angehöriger. Behandle ihn wie ein Passwort.

  • Nutze den Key nur serverseitig. Die API erlaubt zwar Aufrufe aus dem Browser (CORS), aber ein Key im Frontend-Code ist für jeden lesbar.

  • Lege den Key nie in ein Code-Repository, eine Tabelle oder ein Ticket.

  • Hast du den Verdacht, dass jemand deinen Key kennt: Erzeuge sofort einen neuen. Der alte ist damit ungültig.

  • Key und Basis-URL gehören immer zur selben Region.

Hat dies deine Frage beantwortet?