Kom i gang

Autentisering

Hver forespørsel må inneholde API-nøkkelen din. Den identifiserer brukeren din og bestemmer hva svaret kan inneholde.

1Åpne Min konto › API i kontrollpanelet og klikk på Generer nøkkel. Gi nøkkelen et navn som minner deg om hvor den skal brukes, for eksempel «Overvåking».
2Kopier nøkkelen med en gang: Av sikkerhetshensyn vises den bare én gang. Hvis du mister den, må du tilbakekalle den og generere en ny.
3Send nøkkelen i headeren X-API-Key eller som Authorization: Bearer.

Bruk nøkkelen bare på serveren. Legg den aldri inn i nettsider, apper eller lenker: API-et avviser nøkler som sendes i URL-en. Hver bruker kan ha opptil 10 aktive nøkler og kan tilbakekalle hvilken som helst av dem i den samme fanen i kontrollpanelet.

Nøkkelformat

Nøkkelen begynner med apk_, etterfulgt av 48 tegn. I kontrollpanelet vises hver nøkkel bare med begynnelsen, som er den samme verdien som i feltet api_key.prefix i /me.

Tilbakekalle og bytte nøkler

Når du tilbakekaller en nøkkel, blokkeres forespørsler med den umiddelbart. Hvis du vil bytte nøkkel uten å stoppe systemet ditt, genererer du først den nye, bytter den inn på serveren og tilbakekaller først deretter den gamle.

Hvis systemet ditt bare trenger en del av dataene, kan du opprette en egen bruker for det i kontrollpanelet, med bare de nødvendige tillatelsene, og generere nøkkelen i kontoen til denne brukeren.

Hva hver bruker kan se

ForespørselcURLPHPJavaScript

curl "https://api.on-cloud.live/v1/me" \
  -H "X-API-Key: $API_KEY"

<?php
$ch = curl_init('https://api.on-cloud.live/v1/me');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['X-API-Key: ' . getenv('API_KEY')],
]);
$response = json_decode(curl_exec($ch), true);

const res = await fetch('https://api.on-cloud.live/v1/me', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data } = await res.json();

Med headeren Authorization

curl "https://api.on-cloud.live/v1/me" \
  -H "Authorization: Bearer $API_KEY"

Manglende eller tilbakekalt nøkkel401

{
  "error": {
    "code": "invalid_api_key",
    "message": "The API key is invalid or has been revoked."
  }
}