Hapat e parë

Vërtetimi

Çdo kërkesë përmban çelësin tuaj të API-t. Ai identifikon përdoruesin tuaj dhe përcakton se çfarë mund të përmbajë përgjigjja.

1Në panelin e kontrollit, hapni Llogaria ime › API dhe klikoni Krijo çelës. Jepini çelësit një emër që t’ju kujtojë ku do të përdoret, si p.sh. “Monitorimi”.
2Kopjojeni çelësin menjëherë: për arsye sigurie, ai shfaqet vetëm një herë. Nëse e humbisni, shfuqizojeni dhe krijoni një të ri.
3Dërgojeni çelësin në kokën X-API-Key ose si Authorization: Bearer.

Përdoreni çelësin vetëm në server. Mos e vendosni kurrë në faqe interneti, aplikacione ose lidhje: API-ja i refuzon çelësat e dërguar në URL. Çdo përdorues mund të ketë deri në 10 çelësa aktivë dhe mund të shfuqizojë cilindo prej tyre në të njëjtën skedë të panelit të kontrollit.

Formati i çelësit

Çelësi fillon me apk_, i ndjekur nga 48 karaktere. Në panelin e kontrollit, çdo çelës shfaqet vetëm me fillimin e tij, që është e njëjta vlerë si fusha api_key.prefix e /me.

Shfuqizimi dhe zëvendësimi i çelësave

Shfuqizimi i një çelësi bllokon menjëherë kërkesat e bëra me të. Për ta zëvendësuar çelësin pa ndalur sistemin tuaj, krijoni të riun, vendoseni në server dhe vetëm pas kësaj shfuqizoni të vjetrin.

Nëse sistemi juaj ka nevojë vetëm për një pjesë të të dhënave, krijoni në panelin e kontrollit një përdorues vetëm për të, me lejet e nevojshme, dhe krijoni çelësin në llogarinë e atij përdoruesi.

Çfarë mund të shohë secili përdorues

KërkesacURLPHPJavaScript

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

Me kokën Authorization

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

Pa çelës ose me çelës të shfuqizuar401

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