Primeiros passos

Autenticação

Toda requisição leva a sua chave da API. Ela identifica o seu usuário e define o que a resposta pode trazer.

1No painel, abra Minha Conta › API e clique em Gerar chave. Dê um nome que lembre onde a chave será usada, como “Monitoramento”.
2Copie a chave na hora: por segurança, ela aparece uma única vez. Se perder, revogue e gere outra.
3Envie a chave no cabeçalho X-API-Key ou como Authorization: Bearer.

Use a chave só no servidor. Nunca a coloque em páginas, aplicativos ou links: a API recusa chaves enviadas no endereço. Cada usuário pode ter até 10 chaves ativas e pode revogar qualquer uma na mesma aba do painel.

Formato da chave

A chave começa com apk_, seguida de 48 caracteres. No painel, cada chave aparece só pelo início, o mesmo valor do campo api_key.prefix de /me.

Revogar e trocar chaves

Revogar uma chave bloqueia na hora as requisições feitas com ela. Para trocar a chave sem parar o seu sistema, gere a nova, troque no servidor e só então revogue a antiga.

Se o seu sistema só precisa de parte dos dados, crie no painel um usuário só para ele, com as permissões necessárias, e gere a chave na conta desse usuário.

O que cada usuário pode ver

RequisiçãocURLPHPJavaScript

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

Com o cabeçalho Authorization

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

Sem chave ou com chave revogada401

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