Authenticatie- en API-toetsen

API-sleutels, reikwijdtes, de vereisten voor de belangrijkste eigenaar, vervaldatum, rotatie en intrekking.

Openbare API-status

De v1 API maakt gebruik van company-scoped toonder keys en vereist een actieve planning periode. Ontwerp en betaling rapportage eindpunten niet verzenden klantenberichten. Voorbeelden gebruiken plaatshouders .Plakken nooit een echte sleutel in gedeelde code.

Draagsleutels

Stuur uw sleutel in de Authorization header van elk verzoek:

HTTP

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

Verzoeken zonder geldige sleutel retour 401 unauthenticated.

Toepassingsgebied

Elke sleutel heeft één of meerdere scopes. Een verzoek buiten het toepassingsgebied van de sleutel geeft 403 forbidden terug.

Toepassingsgebied	Toelaatt
`receivables:read`	`GET /receivables`, `GET /receivables/{id}`, `GET /reminder-attempts`
`receivables:write`	`POST /receivables`, `PATCH /receivables/{id}`, betalingen, pauzeren, hervatten, annuleren
`usage:read`	`GET /usage`
`payables:read`	`GET /payables`, `GET /payables/{id}`
`payables:write`	`POST /payables`, `PATCH /payables/{id}`, `POST /payables/{id}/mark-paid`

Geef elke integratie alleen de mogelijkheden die het nodig heeft.

Wie kan een sleutel gebruiken?

Een sleutel handelt namens de persoon die het heeft gemaakt, binnen één bedrijf.

de e-mail van de belangrijkste eigenaar wordt geverifieerd en two-factor authenticatie wordt bevestigd,
de belangrijkste eigenaar is nog steeds een actief lid van de onderneming;
het bedrijf zelf actief is.

Als een controle mislukt, geeft het verzoek 403 forbidden terug. Het verwijderen van een teamlid stopt daarom onmiddellijk met de sleutels.

Aanmaken, roteren en terughalen van sleutels

Sleutels worden beheerd in de app onder Settings → API sleutels door eigenaren en beheerders met twee-factor authenticatie.

Een nieuwe sleutel wordt getoond once; RemindCash slaat slechts een hash van.
Sleutels verlopen 30 dagen nadat ze zijn uitgegeven.
Rotate geeft een nieuwe sleutel met dezelfde naam en scopes en verwijdert de oude onmiddellijk. Update uw geheime winkel voor het draaien.
Revoke verwijdert onmiddellijk een sleutel.
Elke persoon kan houden tot 10 actieve sleutels per bedrijf.

Sleutels veilig houden

Sla sleutels op in een geheime manager of omgevingsvariabele, nooit in bronbesturing of front-end code.
Gebruik aparte sleutels voor afzonderlijke systemen, zodat u een kunt herroepen zonder invloed op de anderen.
Als er een sleutel gelekt kan hebben, trek deze dan onmiddellijk in Instellingen in.