Начало работы

Аутентификация

Каждый запрос содержит ваш ключ 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."
  }
}