Mudanças entre as edições de "API de importação de clientes"
Linha 7: | Linha 7: | ||
− | Objeto de entrada | + | == Objeto de entrada == |
{ | { | ||
Linha 16: | Linha 16: | ||
− | Classe cliente | + | == Classe cliente == |
{ | { | ||
Linha 54: | Linha 54: | ||
} | } | ||
+ | Seguem informações complementares sobre cada coluna do layout:</p> | ||
+ | |||
+ | #*Código do credor: aceita apenas valores inteiros e é obrigatório. 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. | ||
+ | #*Celular: aceita no máximo de 20 caracteres e é obrigatório. | ||
+ | #Fixo: aceita no máximo de 20 caracteres e não é obrigatório. | ||
+ | #*Endereco: aceita no máximo de 256 caracteres e é obrigatório. | ||
+ | #*Numero: 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 caracter e não é obrigatório. Se não houver sexo, informar N maiúsculo. | ||
+ | #*Tipo: aceita no máximo de 1 caracter 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. | ||
+ | #Profissao: 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. | ||
+ | #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 (postback) | + | == Classe de retorno (postback) == |
{ | { |
Edição das 20h03min de 17 de fevereiro de 2021
A API de importação de clientes deve ser utilizada para cadastrar um ou mais clientes no Recuperador CRM.
Endpoint: https://www.recuperador.com.br/api/WsImportacaoCliente
Ação: POST
Objeto de entrada
{
atualizar: string, email: string, clientes: array de cliente
}
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
}
Seguem informações complementares sobre cada coluna do layout:
- Código do credor: aceita apenas valores inteiros e é obrigatório. 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.
- Celular: aceita no máximo de 20 caracteres e é obrigatório.
- Fixo: aceita no máximo de 20 caracteres e não é obrigatório.
- Endereco: aceita no máximo de 256 caracteres e é obrigatório.
- Numero: 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 caracter e não é obrigatório. Se não houver sexo, informar N maiúsculo.
- Tipo: aceita no máximo de 1 caracter 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.
- Profissao: 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.
- 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 (postback)
{
sucesso: bool, mensagem: string
}