Kom igång

Autentisering

Varje anrop måste innehålla din API-nyckel. Den identifierar din användare och avgör vad svaret får innehålla.

1Öppna Mitt konto › API i kontrollpanelen och klicka på Generera nyckel. Ge nyckeln ett namn som påminner dig om var den ska användas, till exempel ”Övervakning”.
2Kopiera nyckeln direkt: av säkerhetsskäl visas den bara en gång. Om du tappar bort den återkallar du den och genererar en ny.
3Skicka nyckeln i headern X-API-Key eller som Authorization: Bearer.

Använd bara nyckeln på servern. Lägg aldrig in den i webbsidor, appar eller länkar: API:et avvisar nycklar som skickas i URL:en. Varje användare kan ha upp till 10 aktiva nycklar och kan återkalla vilken som helst av dem på samma flik i kontrollpanelen.

Nyckelformat

Nyckeln börjar med apk_ följt av 48 tecken. I kontrollpanelen visas varje nyckel bara med sin början, som är samma värde som i fältet api_key.prefix i /me.

Återkalla och byta nycklar

När du återkallar en nyckel blockeras anrop med den direkt. Om du vill byta nyckel utan att stoppa ditt system genererar du först den nya, byter till den på servern och återkallar först därefter den gamla.

Om ditt system bara behöver en del av datan kan du skapa en egen användare för det i kontrollpanelen, med bara de behörigheter som behövs, och generera nyckeln i den användarens konto.

Vad varje användare kan se

AnropcURLPHPJavaScript

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 headern Authorization

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

Saknad eller återkallad nyckel401

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