Pular para o conteúdo

Trocar a chave de API por um token de acesso

POST
/v1/token
curl --request POST \
--url https://dash.owiew.com/v1/token \
--header 'Authorization: Bearer <token>'

O primeiro passo de qualquer integração. A chave (adv_...) vai no cabeçalho Authorization — nunca no corpo nem na URL: corpo de requisição aparece em log de aplicação com frequência, e query string aparece em log de proxy sempre.

O token devolvido vale dois minutos. Renove quando expirar; a resposta traz expires_at.

Esta é a única rota que aceita a chave. Todas as outras exigem o token.

Token emitido

Media typeapplication/json
object
access_token
string
expires_at
string format: date-time
tenant_id

O cliente desta chave. Use-o no caminho das rotas de leitura — ele não é escolhido por você.

string format: uuid
tenant_name
string
role
string
Allowed values: viewer analyst
permissions
Array<string>
accounts

As contas de anúncio que esta chave enxerga. ["*"] significa todas as do cliente.

Array<string>

Example

{
"role": "viewer"
}

Chave ausente, malformada, vencida ou revogada. A resposta NÃO distingue os quatro casos: fazê-lo contaria a quem tenta se ele acertou o formato e se a chave já existiu.

Media typeapplication/json
object
error
object
code

Código estável, seguro para comparar.

string
message

Texto para pessoa. Pode mudar entre versões — não decida nada a partir dele.

string
trace_id

Identificador da ocorrência. Cite-o ao pedir suporte.

string

Example generated

{
"error": {
"code": "example",
"message": "example",
"trace_id": "example"
}
}