Kom godt i gang

Godkendelse

Hver forespørgsel skal indeholde din API-nøgle. Den identificerer din bruger og bestemmer, hvad svaret må indeholde.

1Åbn Min konto › API i kontrolpanelet, og klik på Generér nøgle. Giv nøglen et navn, der minder dig om, hvor den skal bruges, f.eks. »Overvågning«.
2Kopiér nøglen med det samme: Af sikkerhedshensyn vises den kun én gang. Hvis du mister den, skal du tilbagekalde den og generere en ny.
3Send nøglen i headeren X-API-Key eller som Authorization: Bearer.

Brug kun nøglen på serveren. Sæt den aldrig ind i websider, apps eller links: API'et afviser nøgler, der sendes i URL'en. Hver bruger kan have op til 10 aktive nøgler og kan tilbagekalde hver af dem under samme fane i kontrolpanelet.

Nøgleformat

Nøglen starter med apk_ efterfulgt af 48 tegn. I kontrolpanelet vises hver nøgle kun med sin begyndelse, som er den samme værdi som i feltet api_key.prefix i /me.

Tilbagekald og udskift nøgler

Når du tilbagekalder en nøgle, blokeres forespørgsler med den med det samme. Hvis du vil udskifte nøglen uden at stoppe dit system, skal du først generere den nye, skifte den ind på serveren og først derefter tilbagekalde den gamle.

Hvis dit system kun har brug for en del af dataene, kan du oprette en bruger kun til systemet i kontrolpanelet, med de nødvendige tilladelser, og generere nøglen på den brugers konto.

Hvad hver bruger kan se

ForespørgselcURLPHPJavaScript

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 tilbagekaldt nøgle401

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