O Bling disponibiliza as operações de inserção, atualização, exclusão e consulta de contratos através de API. Este manual visa demonstrar a utilização de cada um dos métodos da API de contratos.
A homologação de cada método é de suma importância, visto que sem este a integração não estará apta a integrar com o Bling. Além disso quando homologado, o integrador passa a ter um canal direto de suporte técnico para a API, recebe notificações das atualizações com antecedência, tem a divulgação da sua integração no nosso sistema, entre outros benefícios exclusivos. Para saber mais sobre o processo de homologação clique aqui.
Permissões
As permissões de acesso as funcionalidades da API estão definidas conforme abaixo. Além disso, para acessar os métodos o usuário deve possuir uma "apikey" configurada e válida.
| Método na API | Permissão |
| GET | Acesso a contratos |
| POST/PUT | Inclusão e edição de contratos |
| DELETE | Exclusão de contratos |
A APIKEY é obrigatória para executar os métodos da API, e deve ser enviada como um parâmetro da requisição.
| Parâmetro | Descrição | Tipo |
| apikey | Chave única gerada pelo sistema, utilizada para acessar os recursos da API. | STRING |