Primii pași

Autentificare

Fiecare cerere include cheia dumneavoastră API. Aceasta vă identifică utilizatorul și stabilește ce poate conține răspunsul.

1În panoul de control, deschideți Contul meu › API și faceți clic pe Generați o cheie. Dați-i un nume care să vă amintească unde va fi folosită cheia, de exemplu „Monitorizare”.
2Copiați cheia imediat: din motive de securitate, aceasta este afișată o singură dată. Dacă o pierdeți, revocați-o și generați alta.
3Trimiteți cheia în antetul X-API-Key sau ca Authorization: Bearer.

Folosiți cheia doar pe server. Nu o puneți niciodată în pagini web, aplicații sau linkuri: API-ul respinge cheile trimise în URL. Fiecare utilizator poate avea până la 10 chei active și poate revoca oricare dintre ele din aceeași filă a panoului de control.

Formatul cheii

Cheia este formată din apk_ urmat de 48 de caractere. În panoul de control, fiecare cheie este afișată doar prin partea de început, aceeași valoare ca a câmpului api_key.prefix din /me.

Revocarea și înlocuirea cheilor

Revocarea unei chei blochează imediat cererile făcute cu ea. Pentru a înlocui cheia fără a vă opri sistemul, generați-o pe cea nouă, schimbați-o pe server și abia apoi revocați-o pe cea veche.

Dacă sistemul dumneavoastră are nevoie doar de o parte din date, creați în panoul de control un utilizator dedicat, doar cu permisiunile necesare, și generați cheia în contul acestui utilizator.

Ce poate vedea fiecare utilizator

CererecURLPHPJavaScript

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

Cu antetul Authorization

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

Cheie lipsă sau revocată401

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