Darba sākšana

Autentifikācija

Katrā pieprasījumā ir jūsu API atslēga. Tā identificē jūsu lietotāju un nosaka, ko atbilde var saturēt.

1Vadības panelī atveriet sadaļu Mans konts › API un noklikšķiniet uz Izveidot atslēgu. Piešķiriet atslēgai nosaukumu, kas atgādina, kur tā tiks izmantota, piemēram, “Uzraudzība”.
2Nokopējiet atslēgu uzreiz: drošības nolūkos tā tiek parādīta tikai vienu reizi. Ja to pazaudējat, atsauciet to un izveidojiet jaunu.
3Sūtiet atslēgu galvenē X-API-Key vai kā Authorization: Bearer.

Izmantojiet atslēgu tikai serverī. Nekad neievietojiet to tīmekļa lapās, lietotnēs vai saitēs: API noraida atslēgas, kas nosūtītas URL. Katram lietotājam var būt līdz 10 aktīvām atslēgām, un jebkuru no tām var atsaukt tajā pašā vadības paneļa cilnē.

Atslēgas formāts

Atslēga sākas ar apk_, kam seko 48 rakstzīmes. Vadības panelī katra atslēga tiek rādīta tikai ar tās sākumu — tā pati vērtība, kas ir /me laukā api_key.prefix.

Atslēgu atsaukšana un nomaiņa

Atsaucot atslēgu, ar to veiktie pieprasījumi tiek nekavējoties bloķēti. Lai nomainītu atslēgu, neapturot savu sistēmu, izveidojiet jaunu atslēgu, nomainiet to serverī un tikai tad atsauciet veco.

Ja jūsu sistēmai vajadzīga tikai daļa datu, vadības panelī izveidojiet tai atsevišķu lietotāju tikai ar nepieciešamajām atļaujām un izveidojiet atslēgu šī lietotāja kontā.

Ko katrs lietotājs var redzēt

PieprasījumscURLPHPJavaScript

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

Ar galveni Authorization

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

Nav atslēgas vai tā ir atsaukta401

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