Primeiros pasos

Autenticación

Cada solicitude leva a súa chave da API. A chave identifica o seu usuario e define que pode incluír a resposta.

1No panel, abra A miña conta › API e faga clic en Xerar chave. Póñalle un nome que lle lembre onde se vai usar a chave, como «Monitorización».
2Copie a chave nese mesmo momento: por seguridade, só se mostra unha vez. Se a perde, revóguea e xere outra.
3Envíe a chave na cabeceira X-API-Key ou como Authorization: Bearer.

Use a chave só no servidor. Nunca a poña en páxinas web, aplicacións nin ligazóns: a API rexeita as chaves enviadas no enderezo. Cada usuario pode ter ata 10 chaves activas e revogar calquera delas na mesma lapela do panel.

Formato da chave

A chave comeza por apk_, seguida de 48 caracteres. No panel, cada chave só se mostra polo seu comezo, que é o mesmo valor do campo api_key.prefix de /me.

Revogar e substituír chaves

Ao revogar unha chave, as solicitudes feitas con ela bloquéanse de inmediato. Para cambiar de chave sen deter o seu sistema, xere a nova, substitúaa no servidor e só entón revogue a antiga.

Se o seu sistema só necesita unha parte dos datos, cree no panel un usuario exclusivo para el, cos permisos necesarios, e xere a chave na conta dese usuario.

Que pode ver cada usuario

SolicitudecURLPHPJavaScript

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

Coa cabeceira Authorization

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

Sen chave ou cunha chave revogada401

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