Gå til innholdet

Autentisering

REST-API-et bruker API-nøkler. En nøkkel hører til én organisasjon og får rollen du velger når du lager den.

  1. Logg inn i Styrbord og gå til organisasjonen nøkkelen skal gjelde for.
  2. Åpne innstillinger og velg API-nøkler under Utvikler.
  3. Gi nøkkelen et navn som forteller hva den brukes til, og velg tilgang: kun lesing, eller lesing og skriving.
  4. Kopier nøkkelen med det samme. Vi viser den bare én gang.

Behandle nøkkelen som et passord. Får noen tak i den, kan de nå dataene til organisasjonen med rettighetene du ga nøkkelen. Trekk tilbake en nøkkel du ikke lenger bruker.

Send nøkkelen i Authorization-headeren på hvert kall:

Terminal window
curl https://api.styrbord.io/v1/meetings \
-H "Authorization: Bearer sk_din_nokkel_her"

Alle svar er JSON. Kall uten gyldig nøkkel får 401, og kall der rollen ikke strekker til, får 403.

Vi begrenser hvor mange kall en nøkkel kan gjøre, så én integrasjon ikke går ut over andre:

GrenseTakGjelder
Per nøkkel120 kall per minuttAlle /v1-kall
Per nedlasting60 filer per minutt/v1/documents/{id}/content
Per IP-adresse300 kall per minuttAlle kall, også før innlogging

Går du over, får du 429 med en Retry-After-header som sier hvor mange sekunder du bør vente. Bygg inn en pause og prøv igjen — ikke kall i løkke.

Trenger du å hente mye på én gang, bruk limit og offset framfor mange raske kall, og hent bare feltene du faktisk skal bruke.

  • Medlem kan lese: hente møter, saker, aksjebok og resten av innholdet.
  • Administrator kan i tillegg skrive: opprette møter, saker og dokumenter.

Velg lavest mulig rolle for oppgaven nøkkelen skal gjøre.

Se hvilke endepunkter som finnes i API-referansen.