Primeros pasos

Autenticación

Cada petición lleva su clave de API. La clave identifica a su usuario y determina qué puede incluir la respuesta.

1En el panel, abra Mi cuenta › API y haga clic en Generar clave. Póngale un nombre que le recuerde dónde se va a usar la clave, como «Monitorización».
2Copie la clave en ese mismo momento: por seguridad, solo se muestra una vez. Si la pierde, revóquela y genere otra.
3Envíe la clave en la cabecera X-API-Key o como Authorization: Bearer.

Use la clave solo en el servidor. No la incluya nunca en páginas web, aplicaciones ni enlaces: la API rechaza las claves enviadas en la URL. Cada usuario puede tener hasta 10 claves activas y revocar cualquiera de ellas en la misma pestaña del panel.

Formato de la clave

La clave empieza por apk_, seguida de 48 caracteres. En el panel, cada clave se muestra solo por su comienzo, que es el mismo valor del campo api_key.prefix de /me.

Revocar y sustituir claves

Al revocar una clave, las peticiones hechas con ella se bloquean de inmediato. Para cambiar de clave sin detener su sistema, genere la nueva, sustitúyala en el servidor y solo entonces revoque la antigua.

Si su sistema solo necesita una parte de los datos, cree en el panel un usuario exclusivo para él, con los permisos imprescindibles, y genere la clave en la cuenta de ese usuario.

Qué puede ver cada usuario

PeticióncURLPHPJavaScript

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

Con la cabecera Authorization

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

Sin clave o con una clave revocada401

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