Primeiros passos

Autenticação

Todos os pedidos levam a sua chave da API. A chave identifica o seu utilizador e define o que a resposta pode incluir.

1No painel, abra A Minha Conta › API e clique em Gerar chave. Dê-lhe um nome que indique onde a chave vai ser utilizada, como “Monitorização”.
2Copie a chave de imediato: por motivos de segurança, só é apresentada uma vez. Se a perder, revogue-a e gere outra.
3Envie a chave no cabeçalho X-API-Key ou como Authorization: Bearer.

Utilize a chave apenas no servidor. Nunca a coloque em páginas, aplicações ou links: a API recusa chaves enviadas no endereço. Cada utilizador pode ter até 10 chaves ativas e pode revogar qualquer uma delas no mesmo separador do painel.

Formato da chave

A chave é composta por apk_ seguido de 48 caracteres. No painel, cada chave é apresentada apenas pelo início, o mesmo valor do campo api_key.prefix de /me.

Revogar e substituir chaves

Revogar uma chave bloqueia de imediato os pedidos feitos com ela. Para substituir a chave sem parar o seu sistema, gere a nova, atualize-a no servidor e só depois revogue a antiga.

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

O que cada utilizador pode ver

PedidocURLPHPJavaScript

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 a chave revogada401

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