Pierwsze kroki

Uwierzytelnianie

Każde żądanie zawiera Twój klucz API. Identyfikuje on Twojego użytkownika i określa, co może zawierać odpowiedź.

1W panelu sterowania otwórz Moje konto › API i kliknij Wygeneruj klucz. Nadaj kluczowi nazwę, która przypomni Ci, gdzie będzie używany, np. „Monitoring”.
2Od razu skopiuj klucz: ze względów bezpieczeństwa jest wyświetlany tylko raz. Jeśli go zgubisz, unieważnij go i wygeneruj nowy.
3Wysyłaj klucz w nagłówku X-API-Key lub jako Authorization: Bearer.

Używaj klucza tylko na serwerze. Nigdy nie umieszczaj go na stronach internetowych, w aplikacjach ani w linkach: API odrzuca klucze wysłane w adresie. Każdy użytkownik może mieć maksymalnie 10 aktywnych kluczy i może unieważnić dowolny z nich na tej samej karcie panelu sterowania.

Format klucza

Klucz zaczyna się od apk_, po którym następuje 48 znaków. W panelu sterowania każdy klucz jest widoczny tylko w postaci początkowego fragmentu – tej samej wartości co pole api_key.prefix w /me.

Unieważnianie i wymiana kluczy

Unieważnienie klucza natychmiast blokuje żądania wysyłane z jego użyciem. Aby wymienić klucz bez zatrzymywania systemu, wygeneruj nowy, podmień go na serwerze i dopiero wtedy unieważnij stary.

Jeśli Twój system potrzebuje tylko części danych, utwórz dla niego w panelu sterowania osobnego użytkownika tylko z niezbędnymi uprawnieniami i wygeneruj klucz na koncie tego użytkownika.

Co widzi każdy użytkownik

ŻądaniecURLPHPJavaScript

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

Z nagłówkiem Authorization

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

Brak klucza lub klucz unieważniony401

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