Guias

Autenticação

Chave da Conta, idempotência e respostas de acesso.

Toda chamada leva a Chave da Conta no cabeçalho Authorization:

Authorization: Bearer sync_xxxxxxxx_...
  • A Chave é mostrada uma vez, na criação. Guarde-a como senha: quem tem a Chave age pela Conta.
  • A Chave vale como administrador da Conta: acessa o cofre, as execuções e o consumo.
  • Sem Chave ou com Chave inválida → 401.
  • Recurso de outra Conta → 404, como se não existisse.
  • Usuário do portal sem permissão para a rota → 403 papel_sem_acesso.

Idempotência

Os pedidos de execução exigem o cabeçalho Idempotency-Key. Repetir o pedido com a mesma chave devolve a mesma execução, então é seguro reenviar depois de um timeout de rede:

Idempotency-Key: pedido-123

Sem o cabeçalho → 422 idempotency_key_obrigatoria.

Exemplo

curl https://sync.lops.com.br/v1/execucoes?limite=10 \
  -H "Authorization: Bearer $SYNC_CHAVE"
HTTP Significa
401 Chave ausente ou inválida
403 O papel do usuário não acessa esta rota (papel_sem_acesso)
404 O recurso não existe nesta Conta