Oversikt over autentisering
Caution
Demoside - Dette er en demoside som viser frem funksjonen for dokumentasjon med flere faner. Innholdet er kun ment som illustrasjon.
Denne veiledningen forklarer hvordan du autentiserer deg mot API-et vårt. Vi støtter flere autentiseringsmetoder:
API-nøkler
Den enkleste autentiseringsmetoden er å bruke API-nøkler. Hver API-nøkkel er knyttet til en bestemt bruker og har bestemte tillatelser.
// Example API Key requestconst response = await fetch('https://api.example.com/data', { headers: { 'Authorization': 'Bearer YOUR_API_KEY' }});OAuth 2.0
For applikasjoner med høyere sikkerhetskrav støtter vi autentiseringsflyten OAuth 2.0:
- Autorisasjonsforespørsel: Send brukerne videre til autorisasjons-URL-en vår
- Brukersamtykke: Brukeren godkjenner tilgang til kontoen sin
- Autorisasjonskode: Serveren vår returnerer en autorisasjonskode
- Utveksling av token: Bytt koden mot et tilgangstoken
- API-forespørsler: Bruk tilgangstokenet til å nå beskyttede ressurser
JWT-tokener
Etter autentisering utsteder vi JWT-tokener som inneholder kodet informasjon om brukeren og tillatelsene vedkommende har.
// Example JWT token usageconst response = await fetch('https://api.example.com/protected-resource', { headers: { 'Authorization': 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...' }});Håndtering av økter
Økter er gyldige i 24 timer som standard. Slik fornyer du en økt:
const refreshResponse = await fetch('https://api.example.com/auth/refresh', { method: 'POST', headers: { 'Content-Type': 'application/json', 'Authorization': 'Bearer CURRENT_REFRESH_TOKEN' }});
// Parse the new tokensconst { accessToken, refreshToken } = await refreshResponse.json();Beste praksis
- Lagre aldri API-nøkler eller tokener i kode som kjører hos klienten
- Bruk miljøvariabler for sensitive legitimasjonsdata
- Implementer mekanismer for fornying av tokener i applikasjoner som kjører lenge
- Sett fornuftige utløpstider for tokener
- Bruk HTTPS for alle API-forespørsler