API-nøgler og autentificering

Hvert kald til en operation sender en nøgle som bearer-token i headeren Authorization. Det eneste kald uden nøgle er GET /v1/openapi.json, som er offentligt.

curl https://api.komplai.dk/v1/access \
  -H "Authorization: Bearer $KOMPLAI_TOKEN"

Send hele nøglen. API'et læser den kun fra denne header, så den hører aldrig hjemme i en URL. Svar på kald med en nøgle har Cache-Control: private, no-store.

To slags nøgler

komplai gemmer kun en hash af hver nøgle og dens første tegn, så en nøgle kan ikke vises igen, efter den er udstedt. Gem den i jeres hemmelighedshåndtering, aldrig i kode, en URL eller en mail.

Scopes

Et scope giver adgang til en gruppe af operationer. Hver operations side i API-referencen viser de scopes og de slags nøgler, den accepterer.

En personlig API-nøgle kan kun få scopes til værktøjer, du har fået tildelt. Giv den kun de scopes, systemet har brug for. API'et kontrollerer nøglens scopes mod din aktuelle adgang ved hvert kald: Når din tildeling eller organisationens godkendelse af behandlingen ikke længere dækker et værktøj, svarer kaldet 403 insufficient_scope eller 401 invalid_api_key.

Organisationens integrationsnøgle får 403 integration_not_permitted på en operation, den ikke giver adgang til, før dens scopes bliver kontrolleret.

Personlige API-nøgler

Opret en nøgle

Kom i gang viser trinene: API og integrationer › API-nøgler › Opret API-nøgle, derefter formålet, et navn, gyldigheden og rettighederne.

• Nøglen tilhører dig og den organisation, du har valgt i hubben. Er du med i flere organisationer, så skift til den rigtige, før du opretter nøglen.
• Du kan have op til 20 aktive nøgler i hver organisation.
• Når hubben har vist nøglen én gang, viser listen dens navn, nøglens første tegn, dens scopes, status, udløbsdato, og hvornår den sidst blev brugt.

Forny en nøgle

Når du fornyer en nøgle, opretter hubben en ny og tilbagekalder den gamle i samme trin.

Den gamle nøgle holder op med at virke med det samme, så sæt straks den nye nøgle ind i dit system. Et tekstjob kan kun ses med den nøgle, der oprettede det: Hent eller slet dets resultat, før du fornyer. Kun du kan forny dine egne nøgler.

Tilbagekald en nøgle

Vælg Tilbagekald ud for nøglen og derefter Tilbagekald nøgle. Adgang med nøglen stopper straks. Jeres administrator kan se medlemmernes nøgler på samme side og kan også tilbagekalde dem.

Når en nøgle holder op med at virke

• Den når sin udløbsdato, som står under Udløber.
• Du eller jeres administrator tilbagekalder den, eller du fornyer den.
• Du forlader organisationen, eller ingen af de værktøjer, nøglen dækker, er længere tildelt dig.
• Organisationens API-adgang til værktøjet ophører.

Et kald med sådan en nøgle svarer 401 invalid_api_key. Holder nøglen op med at virke, mens et kald kører, svarer kaldet 401 invalid_token.

Organisationens integrationsnøgler

Med organisationens integrationsnøgle kan et af jeres egne systemer, fx en robot eller en integrationsplatform, kalde Redact uden en person. Kald med nøglen registreres under integrationens navn, aldrig under en person.

• Sådan får I en nøgle. Kontakt os med systemets navn, hvad det skal gøre, og en kontaktperson i jeres organisation. komplai udsteder nøglen og leverer den én gang til kontaktpersonen via Secret. Kontaktpersonen får ingen adgang med nøglen og behøver ingen konto.
• Det giver den adgang til. GET /v1/access og Redacts operationer til at finde personoplysninger, pseudonymisere, sætte originalerne tilbage, sende tekstjob og læse PDF- og Word-filer. Chat, Decide, Coding, Registeropslag og engine agentic svarer 403 integration_not_permitted. Redact i Word og Coding-klienten tager kun imod personlige API-nøgler.
• Krav. Nøglen virker, så længe den er aktiv, jeres aftale omfatter Redact via API'et, og behandlingen er godkendt. API'et kontrollerer det ved hvert kald og undervejs i hvert tekstjob. Ophører et af kravene, stopper alle organisationens integrationsnøgler straks.
• Forbrug. Kald tæller med i organisationens grænser for kald og dens månedlige loft for AI-forbrug. En integration har ingen personlig grænse. Grænsen for kald hører til integrationen, så en ny nøgle nulstiller den ikke.
• En ny nøgle. komplai udsteder den næste nøgle til samme integration. Den gamle nøgle stopper i det øjeblik, den nye udstedes, uden overlap, og dens tekstjob, der venter, kører eller er færdige, bliver ugyldige. Skift nøgle mellem jeres systems kørsler.
• Tilbagekaldelse. Jeres administrator åbner Organisation › Login og sikkerhed › Integrationsnøgler, vælger Tilbagekald og derefter Tilbagekald nøgle. Systemet mister straks adgang, job, der venter eller er i gang, stopper, og resultater kan ikke længere hentes. Integrationen findes stadig, så komplai kan udstede en ny nøgle til den.

Siden Integrationsnøgler viser hver integrations navn, kontaktperson, nøgle, status, udløb og seneste brug. Dens statusser:

Det returnerer GET /v1/access

GET /v1/access tæller som ét kald, sender ingen tekst og kører ingen model. Kald det, når dit system starter, og før en kørsel, hvor behandlingen har betydning. Det fulde eksempel står i referencen.

services[].edition udgår og er altid custom. Læs scopes og processing i stedet.