Documentação da API no Painel Cobli
Use a tela Documentação para levar o time de tecnologia aos guias, à referência da API da Cobli e aos atalhos para chaves e webhooks.
A tela Documentação é o ponto de partida para o time de tecnologia da sua empresa integrar a Cobli aos sistemas internos. Ela resume o que a API cobre e leva aos guias do portal docs.cobli.co, às Chaves de API e aos Webhooks.
Pré-requisitos
- Ter a permissão de Integrações no seu perfil de usuário. Se você não vê Documentação no grupo Para desenvolvedores, peça a um administrador da frota para liberar essa permissão.
Como abrir
No menu lateral, clique em Integrações e, no grupo Para desenvolvedores, em Documentação, a primeira opção do grupo. O endereço direto é painel.cobli.co/documentation. Ela também abre pelo botão Acessar documentação das telas Chaves de API e Webhooks e pelo aviso da categoria Automações no catálogo.
O que a tela mostra
De cima para baixo:
- Abrir docs.cobli.co: botão no canto superior direito que abre, em outra aba, o portal completo da documentação da API.
- Guias: três cartões, cada um com um link que abre a parte correspondente de docs.cobli.co em outra aba.
- Tutoriais: primeira chamada, paginação e autenticação, o caminho até o primeiro dado na tela (link Começar).
- Receitas: casos comuns, como acompanhar entregas, importar abastecimentos e espelhar cadastros (link Ver receitas).
- Referência: cada endpoint com parâmetros, respostas e exemplos em Shell, Node, Ruby, PHP e Python (link Abrir referência).
- O que a API cobre: um resumo, só para leitura, das áreas que a API atende, em cinco grupos.
- Operação em campo: Monitoramento, Trajetos, Locais de interesse, Serviços e entregas, Checklists e Comprovantes.
- Segurança: Alertas, Velocidade, Modo de condução e Mídias.
- Cadastros: Veículos, Motoristas, Grupos, Dispositivos e Usuários.
- Custos: Manutenção, Gestão de combustível, Despesas, Cartão combustível, Gastos e Multas.
- Análise: Relatórios e Produtividade.
- Próximos passos: dois atalhos para telas do Painel Cobli. Gerar uma chave ("Pronto para a primeira chamada") leva a Chaves de API, e Criar um endpoint de webhook ("Receber o evento em vez de consultar") leva a Webhooks.
- Para o seu agente de IA: mostra o endereço
docs.cobli.co/llms.txt, um índice em Markdown e OpenAPI que um assistente de IA pode ler. O botão Copiar endereço copia o endereço completo e confirma com Endereço copiado; se o navegador não permitir, aparece Não foi possível copiar o endereço.
Dicas
Para a primeira chamada, o time de tecnologia precisa de uma chave de API gerada por um usuário da frota. Use o atalho Gerar uma chave, em Próximos passos, e combine com o time onde a chave vai ser guardada.
Veja também
- API da Cobli: primeiros passos: o que a API permite e como começar.
- Chaves de API: gere a chave para a primeira chamada.
- Webhooks: receba eventos em vez de consultar.