Початок роботи

Автентифікація

Кожен запит містить ваш ключ API. Він ідентифікує вашого користувача й визначає, які дані може містити відповідь.

1У панелі керування відкрийте розділ Мій обліковий запис › API і натисніть Створити ключ. Дайте ключу назву, з якої буде зрозуміло, де його використовують, наприклад «Моніторинг».
2Скопіюйте ключ одразу: з міркувань безпеки він показується лише один раз. Якщо ключ втрачено, відкличте його й створіть новий.
3Передавайте ключ у заголовку X-API-Key або як Authorization: Bearer.

Використовуйте ключ лише на сервері. Ніколи не розміщуйте його на вебсторінках, у застосунках чи посиланнях: API відхиляє ключі, передані в URL-адресі. Кожен користувач може мати до 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."
  }
}