Első lépések

Hitelesítés

Minden kérésnek tartalmaznia kell az API-kulcsát. Ez azonosítja a felhasználóját, és meghatározza, mit tartalmazhat a válasz.

1A vezérlőpulton nyissa meg a Saját fiók › API menüpontot, és kattintson a Kulcs generálása gombra. Adjon a kulcsnak olyan nevet, amelyből kiderül, hol fogja használni, például „Monitorozás”.
2Azonnal másolja ki a kulcsot: biztonsági okokból csak egyszer jelenik meg. Ha elveszíti, vonja vissza, és generáljon újat.
3A kulcsot az X-API-Key fejlécben vagy Authorization: Bearer formában küldje el.

A kulcsot csak a szerveren használja. Soha ne helyezze el weboldalakon, alkalmazásokban vagy linkekben: az API elutasítja a címben küldött kulcsokat. Minden felhasználónak legfeljebb 10 aktív kulcsa lehet, és bármelyiket visszavonhatja a vezérlőpult ugyanazon a lapján.

A kulcs formátuma

A kulcs apk_ előtaggal kezdődik, amelyet 48 karakter követ. A vezérlőpulton minden kulcsnak csak az eleje látszik, ugyanaz az érték, mint a /me végpont api_key.prefix mezőjében.

Kulcsok visszavonása és cseréje

A kulcs visszavonása azonnal letiltja a vele küldött kéréseket. Ha a rendszere leállítása nélkül szeretne kulcsot cserélni, generálja le az újat, cserélje le a szerveren, és csak ezután vonja vissza a régit.

Ha a rendszerének csak az adatok egy részére van szüksége, hozzon létre neki külön felhasználót a vezérlőpulton, csak a szükséges jogosultságokkal, és ennek a felhasználónak a fiókjában generálja a kulcsot.

Mit láthatnak a felhasználók

KéréscURLPHPJavaScript

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();

Authorization fejléccel

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

Hiányzó vagy visszavont kulcs401

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