Chaves de API

A tela Chaves de API é onde você cria e acompanha as chaves que os sistemas da sua empresa usam para consultar ou enviar dados pela API da Cobli. Use-a quando o time de tecnologia for fazer a primeira integração ou quando uma integração existente parar de funcionar.

Pré-requisitos

Ter a permissão de Integrações no seu perfil de usuário
Saber qual sistema vai usar a chave e quem é o responsável por ele
De preferência, usar um usuário da frota dedicado a integrações (veja Dicas)

Passo a passo

Abra Chaves de API

No menu lateral, clique em Integrações e, no grupo Para desenvolvedores, em Chaves de API. O endereço direto é painel.cobli.co/apis. O cartão Chaves de API do catálogo leva ao mesmo lugar.

Abra o formulário

Clique em Criar chave de API, no canto superior direito. O painel lateral Nova chave de API abre à direita.

Defina um nome

Em Defina um nome para a chave, use um nome que identifique o sistema que vai usar a chave, como Integração ERP ou Relatório BI. O nome aceita até 30 caracteres.

Gere e copie a chave

Clique em Gerar chave. O código aparece em Código da chave. Clique em Copiar chave e guarde o código em local seguro, como um gerenciador de senhas ou a configuração do sistema que vai usá-lo.

Conclua

Clique em Concluir. Depois disso, o código não pode ser visto de novo. Se você tentar fechar o painel antes, a janela Copiou a chave? lembra que fechar sem copiar faz o código se perder.

A chave de API é vinculada ao usuário que a criou. Se esse usuário for desativado da frota, todas as chaves criadas por ele são revogadas automaticamente e param de funcionar. O painel de criação mostra esse aviso em vermelho, junto com o lembrete Copie e salve a chave em local seguro.

O que a tela mostra

Acessar documentação: botão no canto superior direito que leva à tela Documentação do Painel Cobli.
O que a API cobre: quatro cartões que abrem, em outra aba, a parte da referência da API que o time de tecnologia mais consulta, todos com o link Ver endpoints.
- Posição e trajetos: telemetria do dispositivo, previsão de chegada, histórico de passagem e o detalhe de cada trajeto e parada.
- Eventos de segurança: eventos de risco, ranking de condução, excessos de via e de veículo e link temporário para a mídia.
- Cadastros: criação de veículos em lote, associação de dispositivos, cadastro de motoristas e leitura de odômetro e dados CAN.
- Serviços e checklists: criação de rotas, acompanhamento de paradas e leitura de checklists preenchidas, comprovantes, despesas e transações de combustível.
Tabela de chaves: colunas Nome da chave, Último uso, Data de criação, Criado por e Ações.

Como identificar uma chave inválida

Uma chave revogada porque o usuário que a criou foi desativado aparece com o selo vermelho Chave inválida ao lado do nome. Passe o cursor sobre o selo para ver a explicação. Na coluna Criado por, o texto Usuário desativado aparece abaixo do e-mail.

Quando uma integração parar de funcionar, comece por essa verificação: se a chave estiver marcada como inválida, gere uma nova com um usuário ativo e atualize o sistema externo.

Apagar uma chave

Na coluna Ações, clique no ícone de lixeira e confirme em Apagar chave. Só quem criou a chave pode apagá-la: para os demais usuários, o botão fica desativado e mostra A chave só pode ser deletada por seu criador. Apagar uma chave interrompe os sistemas que a usam; avise antes quem os mantém.

Dicas

Crie um usuário exclusivo para integrações, separado dos usuários pessoais da equipe, e use-o para gerar e manter todas as chaves da frota. Assim, a saída de uma pessoa da empresa não derruba as integrações.

Se uma chave parar de funcionar, verifique se o usuário que a criou ainda está ativo na frota, se a chave foi apagada e se a permissão de Integrações continua liberada para o perfil responsável.

Veja também

Como gerar chaves para consumir as APIs da Cobli: o passo a passo com imagens.
Erro "não autorizado" na API: o que verificar quando a chave é recusada.
Documentação: guias e referência para o time de tecnologia.

Nesta página