Chaves de API

Chaves de API permitem acesso programatico aos dados e funcionalidades do Levy Fleets. Crie chaves para integracoes personalizadas, exportacoes de dados e aplicativos de terceiros.

Visao Geral

O Que Chaves de API Fazem

Chaves de API permitem:

• Acesso programatico a dados
• Integracoes de terceiros
• Ferramentas de relatorios personalizados
• Fluxos de trabalho automatizados
• Desenvolvimento de apps moveis

Fluxo de Autenticacao

1. Requisicao inclui cabecalho de chave API
2. Chave e validada
3. Permissoes sao verificadas
4. Requisicao e processada
5. Resposta e retornada

Criando Chaves de API

Passo a Passo

1. Navegue ate Configuracoes > Chaves de API
2. Clique em Criar Chave de API
3. Configure a chave:
   • Nome (para identificacao)
   • Permissoes
   • Expiracao (opcional)
4. Clique em Criar
5. Copie a chave imediatamente

Configuracao da Chave

Melhores Praticas de Nomenclatura

Use nomes descritivos:

• Producao-Integracao-Analytics
• Staging-App-Movel
• Parceiro-XYZ-Acesso
• Ferramenta-Relatorios-Interna

Permissoes

Niveis de Permissao

Permissoes por Recurso

Configure acesso por recurso:

Exemplos de Conjuntos de Permissoes

Integracao de Analytics:

• Corridas: Ler
• Veiculos: Ler
• Clientes: Ler
• Analytics: Ler

App Movel:

• Corridas: Ler, Criar, Atualizar
• Veiculos: Ler
• Clientes: Ler, Atualizar

Ferramenta Admin:

• Todos os recursos: Acesso completo

Usando Chaves de API

Cabecalho HTTP

Inclua a chave no cabecalho Authorization:

Authorization: Bearer SUA_CHAVE_API

Exemplo de Requisicao

curl -X GET "https://api.levyfleets.com/v1/rides" \
  -H "Authorization: Bearer sk_live_abc123..." \
  -H "Content-Type: application/json"

URL Base

Producao: https://api.levyfleets.com/v1 Sandbox: https://api-sandbox.levyfleets.com/v1

Tipos de Chaves

Chaves Live

Para uso em producao:

• Prefixo: sk_live_
• Acessam dados de producao
• Afetam operacoes reais
• Use em sistemas de producao

Chaves de Teste

Para desenvolvimento/testes:

• Prefixo: sk_test_
• Acessam ambiente sandbox
• Seguras para testes
• Nenhum dado real afetado

Gerenciando Chaves

Visualizando Chaves

A pagina de Chaves de API mostra:

• Nome da chave
• Chave parcial (ultimos 8 caracteres)
• Resumo de permissoes
• Data do ultimo uso
• Status

Editando Chaves

Modifique chaves existentes:

1. Clique na chave
2. Atualize nome ou permissoes
3. Salve alteracoes

Revogando Chaves

Para desativar uma chave:

1. Clique na chave
2. Clique em Revogar
3. Confirme a revogacao

Chaves revogadas:

• Param de funcionar imediatamente
• Nao podem ser reativadas
• Permanecem na lista para auditoria

Excluindo Chaves

Para remover permanentemente:

1. Clique na chave
2. Clique em Excluir
3. Confirme a exclusao

Chaves excluidas:

• Removidas da lista
• Nao podem ser recuperadas
• Log de auditoria mantido

Limite de Taxa

Limites Padrao

Cabecalhos de Limite de Taxa

Resposta inclui:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 55
X-RateLimit-Reset: 1640000000

Tratando Limites de Taxa

Quando limite excedido:

• Resposta HTTP 429
• Cabecalho Retry-After
• Implemente backoff exponencial

Melhores Praticas de Seguranca

Armazenamento de Chaves

• Nunca commite chaves no controle de versao
• Use variaveis de ambiente
• Armazene em gerenciador de segredos
• Rotacione chaves regularmente

Rotacao de Chaves

Rotacione chaves periodicamente:

1. Crie nova chave
2. Atualize seus sistemas
3. Teste com nova chave
4. Revogue chave antiga

Monitoramento

Acompanhe uso de chaves:

• Monitore volume de requisicoes
• Observe padroes incomuns
• Configure alertas
• Revise logs de acesso

Principio do Menor Privilegio

• Conceda permissoes minimas necessarias
• Use chaves separadas por integracao
• Nao compartilhe chaves entre ambientes
• Revogue chaves nao usadas

Escopos de Chaves de API

Escopos de Subconta

Limite chaves a subcontas especificas:

• Todas as subcontas
• Apenas subcontas especificas
• Subconta unica

Restricoes de IP

Restrinja uso de chaves por IP:

1. Clique na chave
2. Adicione IPs permitidos
3. Salve alteracoes

Apenas requisicoes de IPs listados funcionarao.

Solucao de Problemas

Autenticacao Falhou

Resposta 401 Unauthorized:

1. Verifique se chave esta correta
2. Verifique se chave nao foi revogada
3. Confirme formato do cabecalho Authorization
4. Verifique se chave nao expirou

Permissao Negada

Resposta 403 Forbidden:

1. Revise permissoes da chave
2. Verifique acesso ao recurso
3. Confirme escopo de subconta
4. Verifique lista de IPs permitidos

Limite de Taxa Atingido

429 Too Many Requests:

1. Verifique cabecalhos de limite de taxa
2. Implemente backoff
3. Solicite aumento de limite
4. Otimize padroes de requisicao

Chave Nao Funciona

Se chave para de funcionar:

1. Verifique status da chave no dashboard
2. Confirme que chave nao foi revogada
3. Verifique expiracao
4. Teste com chave nova

Documentacao da API

Acessando Docs

Documentacao completa da API disponivel em:

• https://docs.levyfleets.com/api
• Especificacao Swagger/OpenAPI
• Explorador de API interativo

Endpoints Disponiveis

SDKs

SDKs oficiais disponiveis:

• JavaScript/TypeScript
• Python
• Ruby
• PHP

---