Ag tosú

Fíordheimhniú

Bíonn d’eochair API i ngach iarratas. Aithníonn sí d’úsáideoir agus socraíonn sí cad is féidir a bheith san fhreagra.

1Sa Phainéal Rialaithe, oscail Mo Chuntas › API agus cliceáil Gin eochair. Tabhair ainm don eochair a mheabhróidh duit cá n-úsáidfear í, mar shampla “Monatóireacht”.
2Cóipeáil an eochair láithreach: ar chúiseanna slándála, ní thaispeántar í ach uair amháin. Má chailleann tú í, cúlghair í agus gin ceann nua.
3Seol an eochair sa cheanntásc X-API-Key nó mar Authorization: Bearer.

Ná húsáid an eochair ach ar d’fhreastalaí. Ná cuir riamh í i leathanaigh ghréasáin, in aipeanna ná i naisc: diúltaíonn an API d’eochracha a sheoltar san URL. Is féidir suas le 10 eochair ghníomhach a bheith ag gach úsáideoir, agus is féidir leis aon cheann acu a chúlghairm sa chluaisín céanna den Phainéal Rialaithe.

Formáid na heochrach

Tosaíonn an eochair le apk_, agus 48 carachtar ina diaidh. Sa Phainéal Rialaithe, ní thaispeántar ach tús gach eochrach, an luach céanna atá sa réimse api_key.prefix de /me.

Eochracha a chúlghairm agus a athsholáthar

Nuair a chúlghairtear eochair, cuirtear bac láithreach ar na hiarratais a dhéantar léi. Chun eochair a athsholáthar gan do chóras a stopadh, gin an ceann nua, cuir in úsáid é ar d’fhreastalaí agus ansin amháin cúlghair an seancheann.

Mura dteastaíonn ach cuid de na sonraí ó do chóras, cruthaigh úsáideoir ar leith dó sa Phainéal Rialaithe, gan ach na ceadanna a theastaíonn uaidh, agus gin an eochair i gcuntas an úsáideora sin.

Cad is féidir le gach úsáideoir a fheiceáil

IarratascURLPHPJavaScript

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

Leis an gceanntásc Authorization

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

Eochair ar iarraidh nó cúlghairthe401

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