Gå til innholdet

Autentisering

Hver forespørsel til Record Meeting API trenger en API-nøkkel. Du oppretter nøkler i appen under Innstillinger ➤ API-nøkler.

API-nøkler-fanen i Innstillinger med knappen Opprett nøkkel

https://api.recordmeeting.com/v1

Endepunktstier i denne referansen er skrevet med /v1-prefikset, for eksempel GET /v1/recordings. Legg dem til https://api.recordmeeting.com.

Send API-nøkkelen din i Authorization-headeren. Nøkler starter med sk_rm_.

Authorization: Bearer sk_rm_your_key

For å opprette en nøkkel, se Brukerveiledning ➤ API-nøkler. En nøkkel har samme tilgang som kontoen din: dine egne opptak og organisasjonsopptakene du har lov til å se.

Terminal window
curl "https://api.recordmeeting.com/v1/recordings" \
-H "Authorization: Bearer sk_rm_your_key"

Vellykkede svar er JSON med resultatet under data. Listeendepunkter som paginerer resultatene sine, legger til et pagination-objekt. Noen svar inneholder også "success": true.

PATCH- og DELETE-forespørsler svarer 204 No Content med en tom body når de lykkes.

Alle feil har dette formatet:

{
"error": {
"code": "ERROR_CODE",
"message": "Human readable description"
}
}

En forespørsel uten en gyldig Authorization-header får 401.

KodeHTTP-statusBetydning
INVALID_API_KEY401Nøkkelen finnes ikke eller er tilbakekalt
API_KEY_EXPIRED401Nøkkelen har utløpt
USER_NOT_FOUND401Kontoen nøkkelen tilhører, finnes ikke lenger
AUTH_ERROR401Autentiseringen mislyktes
KodeHTTP-statusBetydning
VALIDATION_ERROR400Ugyldige eller manglende forespørselsparametere
RECORDING_NOT_READY400Opptaket kan ikke deles ennå
ORGANIZATION_SUBSCRIPTION_EXPIRED402Organisasjonen som eier opptaket, har ikke lenger et aktivt Enterprise-abonnement
FORBIDDEN403Du er ikke medlem av organisasjonen, eller har ikke tilgang til det du ba om
RECORDING_LOCKED403Opptaket er låst. Oppgrader for å åpne det
SUBSCRIPTION_REQUIRED403Handlingen krever en betalt plan
TRANSCRIPT_NOT_AVAILABLE403Transkribering er slått av for organisasjonen eller medlemmet
SHARING_DISABLED403Deling er slått av for organisasjonen eller medlemmet
RECORDING_NOT_FOUND404Opptaket finnes ikke, eller du har ikke tilgang til det
INTERNAL_ERROR500Feil på serversiden