Dechrau arni

Dilysu

Mae pob cais yn cynnwys eich allwedd API. Mae'n adnabod eich defnyddiwr ac yn pennu beth all yr ymateb ei gynnwys.

1Yn y Panel Rheoli, agorwch Fy Nghyfrif › API a chliciwch Cynhyrchu allwedd. Rhowch enw i'r allwedd sy'n eich atgoffa ble bydd yn cael ei defnyddio, fel “Monitro”.
2Copïwch yr allwedd ar unwaith: am resymau diogelwch, dim ond unwaith y caiff ei dangos. Os byddwch yn ei cholli, dirymwch hi a chynhyrchwch un newydd.
3Anfonwch yr allwedd yn y pennyn X-API-Key neu fel Authorization: Bearer.

Defnyddiwch yr allwedd ar eich gweinydd yn unig. Peidiwch byth â'i rhoi mewn tudalennau gwe, apiau na dolenni: mae'r API yn gwrthod allweddi a anfonir yn yr URL. Gall pob defnyddiwr gael hyd at 10 allwedd weithredol, a gall ddirymu unrhyw un ohonynt yn yr un tab yn y Panel Rheoli.

Fformat yr allwedd

Mae'r allwedd yn dechrau gyda apk_, ac yna 48 nod. Yn y Panel Rheoli, dim ond dechrau pob allwedd sy'n cael ei ddangos, sef yr un gwerth â'r maes api_key.prefix yn /me.

Dirymu a newid allweddi

Mae dirymu allwedd yn rhwystro ceisiadau a wneir gyda hi ar unwaith. I newid allwedd heb atal eich system, cynhyrchwch yr un newydd, rhowch hi ar waith ar eich gweinydd, a dim ond wedyn dirymwch yr hen un.

Os mai dim ond rhan o'r data sydd ei hangen ar eich system, crëwch ddefnyddiwr ar ei chyfer yn y Panel Rheoli, gyda dim ond y caniatâd sydd ei angen arni, a chynhyrchwch yr allwedd yng nghyfrif y defnyddiwr hwnnw.

Beth all pob defnyddiwr ei weld

CaiscURLPHPJavaScript

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

Gyda'r pennyn Authorization

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

Allwedd ar goll neu wedi'i dirymu401

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