Op deze pagina
> bronnen > documentatie > api > API sleutels

API-sleutels

API-sleutelbeheer in ProcessMind

Voor integratie met de API van ProcessMind moet je API-sleutels aanmaken en beheren. Lees hoe je API-sleutels genereert, gebruikt en beveiligt.

Ga in de instellingen van je ProcessMind-account naar het gedeelte “API-sleutels”. Hier kun je een nieuwe API-sleutel aanmaken door op de knop Nieuwe API-sleutel voor omgeving te klikken. Geef de sleutel een naam, zodat je die later kunt herkennen.

Een API-sleutel aanmaken

image

Je kunt meerdere API-sleutels aanmaken voor verschillende applicaties of services. Elke sleutel kan afzonderlijk worden beheerd. Zo kun je sleutels intrekken wanneer dat nodig is, zonder andere integraties te beïnvloeden. Zodra de sleutel is gegenereerd, kopieer je die en sla je hem veilig op. Om veiligheidsredenen wordt de sleutel tijdens het aanmaken maar één keer weergegeven.

image

warning

Houd je API-sleutels veilig en zet ze nooit in client-side code of openbare repositories. Als een sleutel is gecompromitteerd, trek je die onmiddellijk in en genereer je een nieuwe.

API-sleutels voor organisaties

Beheerders van organisaties kunnen op dezelfde pagina ook API-sleutels voor organisaties aanmaken. In tegenstelling tot omgevingssleutels werkt een organisatiesleutel in elke omgeving (tenant) van de organisatie. Eén integratie kan daardoor voor alle omgevingen worden gebruikt. Gebruik organisatiesleutels om:

  • API-sleutels voor omgevingen uitgeven: maak tenantgebonden sleutels aan, werk ze bij en verwijder ze via de Externe API (/v1/tenant/{tenantId}/api-keys).
  • Eenmalige inloglinks maken: stuur een gebruiker vanuit je eigen product rechtstreeks naar ProcessMind, al geauthenticeerd (/v1/tenant/{tenantId}/users/{userId}/login-token).

Scopes

Scope Geeft toegang tot
read Tenantdata lezen (list/get-endpoints). Standaard ingeschakeld.
write Tenantdata aanmaken, bijwerken en verwijderen. Standaard ingeschakeld.
uploadData Presigned upload-URL’s aanvragen voor datatables. Standaard ingeschakeld.
sessions Eenmalige tokens voor het doorgeven van een login genereren. Standaard uitgeschakeld.

Schakel sessions alleen in voor sleutels die een login moeten doorgeven. Behandel deze sleutels als wachtwoorden: met een gegenereerd token logt de gebruiker in zonder een wachtwoordprompt. Een organisatiesleutel kan tokens genereren voor gebruikers van elke omgeving binnen de organisatie. Een omgevingssleutel kan dit alleen voor gebruikers van de eigen omgeving.

Eenmalige login doorgeven

POST /v1/tenant/{tenantId}/users/{userId}/login-tokenRetourneert een token dat één keer kan worden gebruikt (60 seconden geldig) en is gekoppeld aan de gebruiker, omgeving en organisatie, plus een url. Stuur de browser van de gebruiker naar die URL. De gebruiker komt dan met een eigen sessie in ProcessMind terecht: zonder e-maillink en zonder impersonatie. Je kunt optioneel een path meegeven in de requestbody om rechtstreeks naar een specifieke pagina te gaan. De sleutel moet de scope sessions hebben. Je kunt alleen een gebruiker aanmaken voor een tenant waarvoor de sleutel gemachtigd is.

Het genereren van tokens wordt vastgelegd in het auditspoor, is streng beperkt in frequentie en wordt onmiddellijk geblokkeerd zodra de sleutel wordt uitgeschakeld of de gebruiker de toegang verliest. Het token wordt één keer teruggegeven en nooit gelogd.

Gerelateerde onderwerpen

Gerelateerde documentatie