Primers passos

Autenticació

Cada sol·licitud porta la vostra clau de l'API. La clau identifica el vostre usuari i determina què pot incloure la resposta.

1Al tauler, obriu El meu compte › API i feu clic a Generar una clau. Doneu-li un nom que us recordi on s'utilitzarà la clau, com ara «Monitoratge».
2Copieu la clau en aquell mateix moment: per motius de seguretat, només es mostra una vegada. Si la perdeu, revoqueu-la i genereu-ne una altra.
3Envieu la clau a la capçalera X-API-Key o com a Authorization: Bearer.

Utilitzeu la clau només al servidor. No la poseu mai en pàgines web, aplicacions ni enllaços: l'API rebutja les claus enviades a l'URL. Cada usuari pot tenir fins a 10 claus actives i pot revocar-ne qualsevol a la mateixa pestanya del tauler.

Format de la clau

La clau comença per apk_, seguida de 48 caràcters. Al tauler, cada clau només es mostra pel començament, que és el mateix valor del camp api_key.prefix de /me.

Revocar i substituir claus

Quan es revoca una clau, les sol·licituds fetes amb aquesta clau es bloquegen immediatament. Per canviar de clau sense aturar el vostre sistema, genereu la nova, substituïu-la al servidor i només llavors revoqueu l'antiga.

Si el vostre sistema només necessita una part de les dades, creeu al tauler un usuari exclusiu per a aquest sistema, amb els permisos necessaris, i genereu la clau al compte d'aquest usuari.

Què pot veure cada usuari

Sol·licitudcURLPHPJavaScript

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

Amb la capçalera Authorization

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

Sense clau o amb una clau revocada401

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