Pular para o conteúdo principal

Acesso pela API

Com a API você automatiza o que faz no portal — criar e listar recursos, consultar a cobrança — a partir de scripts e sistemas.

Gerar o token​

Em Perfil → API, clique em Habilitar API e copie o token.

Token de acesso pessoal — API

O token tem validade: quando expirar, gere outro no mesmo lugar.

Guarde o token como uma senha

O token dá acesso à sua conta como se fosse você. Nunca o coloque em código que vai para um repositório e desabilite a API se ele vazar.

Primeira chamada​

Todas as chamadas usam o endereço https://api.audaks.com.br/api e o cabeçalho Authorization: Bearer SEU_TOKEN. Este exemplo lista os seus projetos:

export AUDAKS_TOKEN="SEU_TOKEN"
curl -s https://api.audaks.com.br/api/projects \
-H "Authorization: Bearer $AUDAKS_TOKEN" \
-H "Accept: application/json"

Resposta esperada (resumida):

{
"status": "Success",
"data": [
{ "name": "Default", "slug": "default-...", "description": "Your first project." }
]
}

Sem token, ou com o token vencido, a API responde:

{ "status": "Error", "message": "Unauthenticated." }

Referência completa​

A lista de todas as chamadas disponíveis está nas referências da API (geradas automaticamente, em inglês):

Problemas comuns​

SintomaCausa provávelSolução
Unauthenticated.Token errado, incompleto ou vencidoGere um token novo em Perfil → API
Unauthenticated. mesmo com token novoO cabeçalho Authorization foi escrito erradoConfira o formato exato: Authorization: Bearer SEU_TOKEN (com espaço depois de Bearer)