Visão geral da API

De Recuperador CRM | Documentação
Ir para: navegação, pesquisa

Presente em User > Perfil > botão API, a tela permite visualizar ou criar um novo token de acesso à API de importação de dados.

A API é um recurso utilizado para integração de sistemas. No Recuperador CRM, a API permite que sistemas de terceiros importem dados diretamente para o Recuperador CRM, evitando a utilização de planilhas. Dessa forma, é possível criar rotinas de importação para automatizar, agilizar e simplificar a alimentação do sistema.

Nesta versão da API, existem métodos para a importação de Clientes, Dívidas e Follow-ups.

Tecnicamente, é necessário gerar um token para viabilizar as chamadas dos métodos da API. Em linhas gerais, o token é como se fosse uma senha específica para permitir o acesso à API. Para gerar um token ou substituir o token atual, clique no botão Gerar token.

Todos os métodos precisam ser autenticados pelo token. O token deve ser informado no campo username da autenticação Basic Auth. O campo password deverá ficar em branco.

Os métodos deverão ser chamados via POST passando um objeto JSON como parâmetro de acordo com o método escolhido.

A saída poderá ser uma lista ou um objeto contendo dois campos: sucesso e mensagem. O campo sucesso retornará true em caso de chamada realizada com sucesso e false em caso de erro na chamada. O campo mensagem exibirá a mensagem de sucesso ou de erro.