Autenticação

A API Zyraq utiliza API Keys para autenticação. Cada chave está vinculada a um time específico e tem acesso aos recursos autorizados para esse time.

Formato da API Key

As chaves de API seguem o padrão:

Tipo	Prefixo	Exemplo
Produção	`ea_live_`	`ea_live_8f92k3d7a9b2c4e6f8g0h1i2j3...`
Teste	`ea_test_`	`ea_test_a1b2c3d4e5f6g7h8i9j0k1l2...`

Use chaves ea_test_ para desenvolvimento e ea_live_ para produção.

Importante

A API Key é exibida apenas uma vez no momento da criação. Se você perder a chave, será necessário gerar uma nova.

Obtendo suas Chaves

Acesse o painel de API Keys

Navegue até Configurações → API Keys no painel da Zyraq.

Gere uma nova chave

Clique em "Gerar Nova Chave". Você pode criar múltiplas chaves para diferentes ambientes (produção, staging, desenvolvimento).

Copie e armazene com segurança

A chave completa só é exibida uma vez. Copie e armazene em um local seguro como:

Variáveis de ambiente
Secrets manager (AWS, GCP, Azure)
HashiCorp Vault

Formato do Header

Inclua o header Authorization em todas as requisições:

Authorization: Bearer ea_live_sua_chave_aqui
Content-Type: application/json

Exemplos de Autenticação

curl -X GET https://app.zyraqgroup.com/api/v1/vehicles \
  -H "Authorization: Bearer ea_live_sua_chave_aqui" \
  -H "Content-Type: application/json"

Vinculação com Time (Team)

Cada API Key está vinculada a um time específico. Isso permite:

Controle de acesso: Cada time tem suas próprias chaves
Isolamento de dados: Só acessa recursos do time vinculado
Auditoria: Requisições são rastreadas por chave

Gerenciamento de Chaves

Listando Chaves

No painel de API Keys você pode ver:

Prefixo da chave: Primeiros caracteres para identificação
Data de criação: Quando a chave foi gerada
Último uso: Última vez que a chave foi utilizada
Status: Ativa ou inativa

Revogando Chaves

Para revogar uma chave comprometida:

Acesse Configurações → API Keys
Localize a chave pelo prefixo
Clique em "Revogar"
Confirme a ação

A revogação é imediata e irreversível. Todas as requisições usando esta chave passarão a retornar 401 Unauthorized.

Rotação de Chaves

Recomendamos rotacionar suas chaves periodicamente (a cada 90 dias):

Gere uma nova chave
Atualize suas aplicações para usar a nova chave
Monitore que tudo está funcionando
Revogue a chave antiga

Erros de Autenticação

Código	Erro	Descrição	Solução
`401`	`Missing Authorization header`	Header não presente	Adicione o header `Authorization`
`401`	`Invalid API key format`	Formato incorreto	Use o formato `Bearer ea_live_...`
`401`	`Invalid API key`	Chave não encontrada	Verifique se a chave existe e está ativa
`403`	`Forbidden`	Sem permissão	Verifique as permissões do time

Exemplo de Resposta de Erro

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "API Key inválida ou ausente"
  }
}

Boas Práticas de Segurança

Faça

Armazene chaves em variáveis de ambiente
Use secrets managers em produção
Rotacione chaves periodicamente (a cada 90 dias)
Use chaves de TESTE para desenvolvimento
Monitore o uso das chaves

Não Faça

Commitar chaves em repositórios Git
Expor chaves em código front-end ou logs
Compartilhar chaves entre desenvolvedores
Usar chaves de teste em produção
Deixar chaves antigas ativas sem uso

Testando a Autenticação

Verifique se sua chave está funcionando:

curl -X GET https://app.zyraqgroup.com/api/v1/vehicles \
  -H "Authorization: Bearer ea_live_sua_chave_aqui"

Resposta de sucesso:

{
  "success": true,
  "data": [],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 0,
    "pages": 0
  }
}

Resposta de erro:

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "API Key inválida"
  }
}

Suporte

Problemas com autenticação?

Email: suporte@zyraqgroup.com
Documentação: Início Rápido

Autenticação

On this page