API de importação de follow-ups

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

A API de importação de follow-ups deve ser utilizada para cadastrar um ou mais follow-ups (ocorrências) para clientes no Recuperador CRM.


Endpoint: https://www.recuperador.com.br/api/v1ImportacaoNegociacao

Ação: POST

Formato: JSON

Autenticação: enviar o token da API no campo username da autenticação Basic Auth. Deixe o campo password em branco.


Objeto de entrada

{

   email: string, 
   negociacoes: array de negociacao

}

Seguem informações complementares sobre cada coluna do objeto:

  • E-mail: e-mail que receberá o resultado da importação. Este método é assíncrono, por isso deve-se informar um endereço de e-mail para recebimento do resultado do processamento.
  • Negociacoes: lista de follow-ups a serem importados. O array deve ser do tipo negociacao, que será descrito abaixo.


Classe negociacao

{

   id_credor: int
   cpf_cnpj: string, 
   nome_cliente: string, 
   data: DateTime,
   interacao: string

}

Seguem informações complementares sobre cada coluna do objeto:

  • ID do credor: aceita apenas valores inteiros e é obrigatório. Ele deve ser preenchido com o código do credor que aparece em Cadastros > Credores.
  • CPF/CNPJ: aceita no máximo de 18 caracteres e é obrigatório. Somente números preferencialmente.
  • Nome do cliente: aceita no máximo 40 caracteres e é obrigatório.
  • Data: aceita no máximo 10 caracteres no formato AAAA-MM-DD e é obrigatório.
  • Interacao: aceita no máximo 2.000 dígitos e é obrigatório.

Importante: todos os campos são obrigatórios.


Classe de retorno

{

   sucesso: bool,
   mensagem: string

}

Seguem informações complementares sobre cada coluna do objeto:

  • Sucesso: retornará true em caso de chamada realizada com sucesso e false em caso de erro na chamada.
  • Mensagem: exibirá a mensagem de sucesso ou de erro.