Manual da Cobli

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.

Passo a passo

Acessar a página de gerenciamento das chaves

No painel da Cobli, acesse Configurações > Integrações > APIs.

Menu Integrações com a opção APIs no painel da Cobli

Gerar uma chave de API

Na página de APIs, clique em Criar chave de API, no canto superior direito.

Botão Criar chave de API na página de APIs

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:

Exemplo de requisição com o header cobli-api-key na documentação da API

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.

Ação de apagar chave na listagem de chaves de API

Veja também

Nesta página