Como gerar chaves para consumir as APIs da Cobli?
Criar, usar e apagar as chaves de API que autenticam as requisições nas APIs da Cobli.
A Cobli possui uma API que você pode usar para fazer integrações com outros sistemas da sua empresa. Para consumir essas APIs é preciso autorização, e ela é feita por meio das chaves de API. Este artigo mostra como gerar a sua.
A documentação da API fica em docs.cobli.co. Na própria tela Chaves de API, o botão Acessar documentação (canto superior direito) leva à tela Documentação do Painel Cobli, com guias, o resumo do que a API cobre e o link para docs.cobli.co, e a faixa O que a API cobre traz atalhos Ver endpoints para posição e trajetos, eventos de segurança, cadastros e serviços e checklists.
Passo a passo
Acessar a página de gerenciamento das chaves
No Painel Cobli, clique em Integrações no menu lateral e, no grupo Para desenvolvedores, em Chaves de API. O endereço direto é painel.cobli.co/apis.
Gerar uma chave de API
Na página Chaves de API, clique em Criar chave de API, no canto superior direito, ao lado de Acessar documentação.
Digite um nome que ajude a identificar a chave e clique em Gerar chave. Com a chave criada, use o botão Copiar chave e guarde-a em um local seguro.
Por motivos de segurança, você não conseguirá mais consultar a chave no painel. Em caso de perda, será necessário gerar uma nova. Trate a chave como uma senha.
Utilizar a chave nas integrações
Envie a chave no header da requisição, com o nome cobli-api-key. Este é um exemplo de requisição feita na documentação da Cobli:
Pronto: a requisição já tem a autorização necessária para consumir as APIs.
Apagar uma chave de API
Você pode excluir uma chave a qualquer momento: passe o cursor sobre ela na lista e clique em apagar chave. Depois de apagada, a chave não pode mais ser usada — será necessário criar uma nova.
Veja também
- API da Cobli: primeiros passos
- Fiz uma requisição de API e recebi "não autorizado"
- Chaves de API: a tela do painel onde as chaves são criadas e acompanhadas.