Първи стъпки

Удостоверяване

Всяка заявка съдържа вашия API ключ. Той идентифицира вашия потребител и определя какво може да съдържа отговорът.

1В контролния панел отворете Моят акаунт › API и щракнете върху Създай ключ. Дайте на ключа име, което да ви напомня къде ще се използва, например „Мониторинг“.
2Копирайте ключа веднага: от съображения за сигурност той се показва само веднъж. Ако го загубите, анулирайте го и създайте нов.
3Изпращайте ключа в заглавката X-API-Key или като Authorization: Bearer.

Използвайте ключа само на сървъра. Никога не го поставяйте в уеб страници, приложения или връзки: API отхвърля ключове, изпратени в адреса. Всеки потребител може да има до 10 активни ключа и може да анулира всеки от тях в същия раздел на контролния панел.

Формат на ключа

Ключът започва с apk_, следван от 48 знака. В контролния панел всеки ключ се показва само с началото си — същата стойност като в полето api_key.prefix на /me.

Анулиране и смяна на ключове

Анулирането на ключ веднага блокира заявките, направени с него. За да смените ключа, без да спирате системата си, създайте новия, сменете го на сървъра и едва тогава анулирайте стария.

Ако системата ви се нуждае само от част от данните, създайте в контролния панел отделен потребител за нея само с нужните права, а ключа създайте в акаунта на този потребител.

Какво вижда всеки потребител

ЗаявкаcURLPHPJavaScript

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

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

Липсващ или анулиран ключ401

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