API de importação de clientes

A API de importação de clientes deve ser utilizada para cadastrar um ou mais clientes no Recuperador CRM.

Endpoint: https://app.recuperador.com.br/api/v1ImportacaoCliente

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

{

   atualizar: string,
   email: string, 
   clientes: array de cliente,
   interromper_duplicidade: string

}

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

• Atualizar: deve ser preenchido com S para Sim e N para Não. Quando marcado como S, este campo faz o importador atualizar CPFs ou CNPJs existentes na base de dados com os novos dados.
• 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.
• Clientes: lista de clientes a serem importados. O array deve ser do tipo cliente, que será descrito abaixo.
• Interromper por duplicidade: deve ser preenchido com S para Sim e N para Não. Quando marcado com N, não exibe o erro de duplicidade e pode ser útil em importações incrementais. Válido apenas quando o campo Atualizar for igual a N (Não).

Classe cliente

{

   id_credor: int
   nome: string, 
   apelido: string,
   datanasc: DateTime,
   email: string,
   email2: string, 
   email3: string, 
   email4: string, 
   telefone: string, 
   telefone2: string, 
   endereco: string, 
   numero: string, 
   complemento: string, 
   bairro: string, 
   cidade: string, 
   estado: string, 
   cep: string, 
   sexo: string, 
   rg: string, 
   tipo_pessoa: string, 
   cpf_cnpj: string, 
   whatsapp: string, 
   telegram: string, 
   profissao: string, 
   responsavel_legal: string, 
   username_fb: string, 
   username_insta: string, 
   telefone3: string, 
   telefone4: string, 
   telefone5: string, 
   telefone6: string, 
   codigo: string, 
   obs: string, 
   nome_mae: string, 
   score_credito: string

}

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

• *ID do credor: aceita apenas valores inteiros e é obrigatório somente na importação de múltiplos credores. Ele deve ser preenchido com o código do credor que aparece em Cadastros > Credores.
• *Nome: aceita no máximo de 40 caracteres e é obrigatório.
• Apelido: aceita no máximo de 40 caracteres e não é obrigatório.
• Data nasc.: aceita no máximo 10 caracteres no formato DD/MM/AAAA e não é obrigatório.
• *E-mail: aceita no máximo de 256 caracteres e é obrigatório.
• E-mail 2: aceita no máximo de 256 caracteres e não é obrigatório.
• E-mail 3: aceita no máximo de 256 caracteres e não é obrigatório.
• E-mail 4: aceita no máximo de 256 caracteres e não é obrigatório.
• *Telefone: aceita no máximo de 20 caracteres e é obrigatório.
• Telefone2: aceita no máximo de 20 caracteres e não é obrigatório.
• *Endereço: aceita no máximo de 256 caracteres e é obrigatório.
• *Número: aceita no máximo de 5 caracteres e é obrigatório.
• Complemento: aceita no máximo de 150 caracteres e não é obrigatório.
• *Bairro: aceita no máximo de 60 caracteres e é obrigatório.
• *Cidade: aceita no máximo de 60 caracteres e é obrigatório.
• *Estado: aceita no máximo de 2 caracteres e é obrigatório.
• *CEP: aceita no máximo de 9 caracteres e é obrigatório. Somente números preferencialmente.
• Sexo: aceita no máximo de 1 caractere e não é obrigatório. Deve ser preenchido com M ou F. Se não houver sexo, informar N maiúsculo.
• *Tipo: aceita no máximo de 1 caractere e é obrigatório. Informar F maiúsculo para pessoa física ou J maiúsculo para pessoa jurídica.
• *CPF/CNPJ: aceita no máximo de 18 caracteres e é obrigatório. Somente números preferencialmente.
• RG: aceita no máximo de 12 caracteres e não é obrigatório.
• WhatsApp: aceita no máximo de 20 caracteres e não é obrigatório.
• Telegram: aceita no máximo de 20 caracteres e não é obrigatório.
• Profissão: aceita no máximo de 100 caracteres e não é obrigatório.
• Resp. Legal: aceita no máximo de 100 caracteres e não é obrigatório.
• Facebook: aceita no máximo de 256 caracteres e não é obrigatório.
• Instagram: aceita no máximo de 256 caracteres e não é obrigatório.
• Telefone de recado 1: aceita no máximo de 20 caracteres e não é obrigatório.
• Telefone de recado 2: aceita no máximo de 20 caracteres e não é obrigatório.
• Telefone de recado 3: aceita no máximo de 20 caracteres e não é obrigatório.
• Telefone de recado 4: aceita no máximo de 20 caracteres e não é obrigatório.
• Código do cliente: aceita no máximo de 100 caracteres e não é obrigatório.
• Observações: aceita no máximo de 400 caracteres e não é obrigatório.
• Nome da mãe: aceita no máximo de 40 caracteres e não é obrigatório.
• Score de crédito: aceita no máximo de 40 caracteres e não é obrigatório.

Se o parâmetro Exigir dados completos do cliente estiver configurado como Não no cadastro do credor, então não será obrigatório informar o e-mail, telefone, data de nascimento e endereço completo do cliente.

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.