Authentifizierung und API Keys

Bearer-API-Schlüssel, Scopes, die Anforderungen an den Schlüsselbesitzer, Ablauf, Rotation und Widerruf.

Public API Status

Die v1-API verwendet unternehmensweit erfasste Trägerschlüssel und erfordert einen aktiven Planzeitraum. Endpunkte für Entwurfs- und Zahlungsberichte senden keine Kundennachrichten. Beispiele verwenden Platzhalter — fügen Sie niemals einen echten Schlüssel in einen freigegebenen Code ein.

Trägerschlüssel

Senden Sie Ihren Schlüssel im Authorization-Header jeder Anfrage:

HTTP

GET /v1/receivables HTTP/1.1
Host: api.remindcash.com
Authorization: Bearer <your-api-key>
Accept: application/json

Anfragen ohne gültigen Schlüssel geben 401 unauthenticated zurück.

Anwendungsbereiche

Jeder Schlüssel trägt einen oder mehrere Scopes. Eine Anforderung außerhalb des Scopes des Schlüssels gibt 403 forbidden zurück.

Anwendungsbereich	erlaubt
`receivables:read`	`GET /receivables`, `GET /receivables/{id}`, `GET /reminder-attempts`
`receivables:write`	`POST /receivables`, `PATCH /receivables/{id}`, Zahlungen, Pause, Lebenslauf, Stornierung
`usage:read`	`GET /usage`
`payables:read`	`GET /payables`, `GET /payables/{id}`
`payables:write`	`POST /payables`, `PATCH /payables/{id}`, `POST /payables/{id}/mark-paid`

Geben Sie jeder Integration nur die Bereiche, die sie benötigt.

Wer kann einen Schlüssel verwenden

Ein Schlüssel handelt im Namen der Person, die ihn geschaffen hat, innerhalb eines Unternehmens. Jede Anfrage überprüft, dass:

die E-Mail des Schlüsselbesitzers wird verifiziert und die Zwei-Faktor-Authentifizierung wird bestätigt;
der Haupteigentümer ist weiterhin ein aktives Mitglied des Unternehmens,
Das Unternehmen selbst ist aktiv.

Wenn eine Überprüfung fehlschlägt, gibt die Anforderung 403 forbidden zurück. Das Entfernen eines Teammitglieds stoppt daher sofort seine Schlüssel.

Erstellen, Drehen und Entziehen von Schlüsseln

Schlüssel werden in der App unter Settings → API-Schlüssel von Firmeninhabern und Administratoren mit Zwei-Faktor-Authentifizierung verwaltet.

Ein neuer Schlüssel wird angezeigt once; RemindCash speichert nur einen Hash davon.
Schlüssel verfallen 30 Tage, nachdem sie ausgegeben wurden.
Rotate gibt einen neuen Schlüssel mit dem gleichen Namen und Umfang aus und löscht den alten sofort.
Revoke löscht einen Schlüssel sofort.
Jede Person kann bis zu 10 aktive Schlüssel pro Unternehmen halten.

Schlüssel sicher halten

Speichern Sie Schlüssel in einer geheimen Manager- oder Umgebungsvariablen, niemals in der Quellsteuerung oder im Front-End-Code.
Verwenden Sie separate Schlüssel für separate Systeme, damit Sie eines widerrufen können, ohne die anderen zu beeinträchtigen.
Wenn ein Schlüssel möglicherweise durchgesickert ist, widerrufen Sie ihn sofort in den Einstellungen.