Introdução

A Cobli possui uma API (Application Program Interface) que você pode utilizar para fazer integrações com outros sistemas da sua empresa.

Você pode acessar a documentação da API por meio desse link: https://docs.cobli.co/

Para que seja possível realizar essas integrações, você precisa de autorização das nossas APIs, e na Cobli, isso é feito por meio das chaves API. Você aprenderá a gerar sua chave no guia abaixo:

Passo 1: acessar a página de gerenciamento das chaves

Primeiramente, precisamos acessar a página de controle das chaves de API, para isso, você deve acessar o painel da Cobli e acessar a guia de Configurações gerais, localizada no final do menu lateral esquerdo:

Depois de acessarmos a guia de configurações, precisamos acessar a guia de Chaves de API, o último link da aba lateral esquerda:

Passo 2: gerar uma chave API

Depois de acessar a página de gerenciamento de chaves API, podemos criar uma nova chave, basta selecionarmos o botão Nova Chave de API, localizada no canto superior direito:

Depois, digite um nome para a chave, um nome que te ajude a identificá-la, depois clique em Gerar chave.

Depois de clicar no botão, a sua chave será gerada, basta copiá-la utilizando o botão Copiar chave, depois, guarde-a em um local seguro. Agora a chave está pronta para ser utilizada em integrações, mas lembre-se, por motivos de segurança, você não conseguirá mais consultá-la no painel. No caso de perda da chave, deverá gerar uma nova.

Obs: Você pode a qualquer momento excluir suas chaves, basta passar o cursor do mouse na chave, e apertar o botão apagar chave. Depois que a chave ser apagada, ela não poderá ser mais utilizada, sendo necessário criar uma nova.

Passo 3: utilizar a chave API nas integrações

Agora que criamos a nossa chave API, podemos usá-la para consumir as APIs da Cobli. Para isso, basta enviarmos a chave no Header da requisição com o nome cobli-api-key ao fazer a requisição. Aqui temos um exemplo de uma requisição de API realizada na ferramenta Insomnia:

E pronto, você já tem a autorização necessária para consumir nossas APIs.

Obrigado,

Time Cobli

Encontrou sua resposta?