Spring til indhold

Sådan laver I en API-nøgle

2 min læsning

Sådan gør du

  1. Gå til Indstillinger → API og integrationer → API-nøgler.
  2. Giv nøglen et navn, der siger, hvilket system den er til.
  3. Vælg de scopes, den skal have. Ingen er valgt på forhånd.
  4. Kopiér nøglen med det samme — den vises kun én gang.

Tre regler

  • Én nøgle pr. system. Så kan én tilbagekaldes uden at slukke for resten.
  • Kun de scopes, der skal bruges. Ikke alle, fordi det er nemmest.
  • Tilbagekald, når nogen stopper, eller når et system udfases.

Grænsen for antal kald tælles pr. konto, ikke pr. nøgle: Basis 60, Plus 300 og Skala 1.200 kald i minuttet.

Scopes, det er værd at kende

ScopeGiver
contacts:read / contacts:writeKartoteket og mærkater
contacts:exportALT om én person, inkl. samtaler — kun til indsigtsanmodninger
calls:readOpkald, resuméer og transskripter
calls:writeMarkere opkald ordnet og sætte etiketter
recordings:readSelve lyden
bookings:read / bookings:writeAftaler og ledige tider
checkin:writeKun at melde ankomst — til en skærm i venteværelset
tasks:read / tasks:writeBeskeder om at ringe tilbage
sms:read / sms:writeLæse og sende sms
blocks:read / blocks:writeSpærrede numre
webhooks:read / webhooks:writeModtagere af hændelser

contacts:export følger IKKE med contacts:read. En nøgle, der kun skal slå et nummer op, skal ikke kunne hente hver samtale, en patient har haft.

Webhook-hemmeligheden

Hemmeligheden til en webhook vises også kun én gang. Er den tabt, laves en ny under API og integrationer eller med POST /v1/webhooks/{id}/rotate-secret. Den gamle holder op med at virke med det samme.

Den fulde dokumentation står på telefonai.dk/docs.

Var dette nyttigt?