Introdução

                        

API Endpoint
https://api.crmtony.com.br/v3/

Esse documento descreve como funciona o serviço de API do CRMTony.

- Para utilizar nossa SDK JS: uncompressed ou minified.

- Para utilizar nossa SDK PHP: RAW.

Clientes

Manipulação de clientes

create

Criação de cliente
https://api.crmtony.com.br/v3/Clients/create

Coming Soon

Coming Soon

                                                import requests

url = Clients/create
querystring =
                                                # Clique aqui para visualizar o SDK
$.CRMTony('Clients/create', [], { "nome": "String", "cpf": "CPF (XXXX.XXXX.XXXX-XX)", "rg": "String", "nascimento": "Data (YYYY-MM-DD ou DD\/MM\/YYYY)", "cidade": "String", "email": "String", "telefone": "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)", "celular": "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)", "whatsapp": "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)", "0km": "Options", "placapretendida": "String", "carropretendido": "String", "anopretendido": "String", "valorcarro": "Número (XXXX.XX ou X.XXX,XX)", "entrada": "Número (XXXX.XX ou X.XXX,XX)", "qtdeparcelas": "Inteiro", "parcela": "Número (XXXX.XX ou X.XXX,XX)", "horario_contato": "Hora (HH)", "troca_placa": "String", "troca_tipo": "Options", "troca_marca": "String", "troca_modelo": "String", "troca_ano": "String", "troca_valor": "Número (XXXX.XX ou X.XXX,XX)", "troca_pago": "Número (XXXX.XX ou X.XXX,XX)", "troca_km": "Inteiro", "troca_debito": "Número (XXXX.XX ou X.XXX,XX)", "formapagamento": "Options", "negativado": "Options", "tipo": "Options", "origem": "Hash", "oportunidade": "Bool (true ou 1, false ou 0)", "usuario": "Inteiro", "ref": "String", "url": "String", "origem_add": "String", "observacao": "String" }, function(successData){
console.log(successData);
}, function(errorData){
console.log(errorData);
});
                                                # Clique aqui para visualizar o SDK
$crmtony = new CRMTony();
$data = $crmtony->run('Clients/create', [], [
    "nome" => "String",
    "cpf" => "CPF (XXXX.XXXX.XXXX-XX)",
    "rg" => "String",
    "nascimento" => "Data (YYYY-MM-DD ou DD/MM/YYYY)",
    "cidade" => "String",
    "email" => "String",
    "telefone" => "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)",
    "celular" => "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)",
    "whatsapp" => "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)",
    "0km" => "Options",
    "placapretendida" => "String",
    "carropretendido" => "String",
    "anopretendido" => "String",
    "valorcarro" => "Número (XXXX.XX ou X.XXX,XX)",
    "entrada" => "Número (XXXX.XX ou X.XXX,XX)",
    "qtdeparcelas" => "Inteiro",
    "parcela" => "Número (XXXX.XX ou X.XXX,XX)",
    "horario_contato" => "Hora (HH)",
    "troca_placa" => "String",
    "troca_tipo" => "Options",
    "troca_marca" => "String",
    "troca_modelo" => "String",
    "troca_ano" => "String",
    "troca_valor" => "Número (XXXX.XX ou X.XXX,XX)",
    "troca_pago" => "Número (XXXX.XX ou X.XXX,XX)",
    "troca_km" => "Inteiro",
    "troca_debito" => "Número (XXXX.XX ou X.XXX,XX)",
    "formapagamento" => "Options",
    "negativado" => "Options",
    "tipo" => "Options",
    "origem" => "Hash",
    "oportunidade" => "Bool (true ou 1, false ou 0)",
    "usuario" => "Inteiro",
    "ref" => "String",
    "url" => "String",
    "origem_add" => "String",
    "observacao" => "String",
]);

echo json_encode($data);
                                                {
    "message": "Cliente cadastrado com sucesso",
    "cliente_token": "72f25033fbd50d33e3e2e26d33fd887d",
    "url": "https://site.com.br/Obrigado/8d8c66aa95a69795b0920184aa9f9f15/"
}
                                            
                                                {
    "erro": "Parâmetros body inválidos",
    "message": "Por favor, informe o(s) campo(s): nome"
}
                                            

BODY PARAMETERS

Field Type Description
nome * String Nome completo
cpf CPF (XXXX.XXXX.XXXX-XX) CPF
rg String RG
nascimento Data (YYYY-MM-DD ou DD/MM/YYYY) Data de nascimento
cidade String Cidade
email String E-mail
telefone Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999) Telefone
celular Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999) Celular
whatsapp Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999) WhatsApp
0km Options:
0 - Não
1 - Sim
(Padrão: 0)
placapretendida String Placa do veículo escolhido
carropretendido String Descrição do veículo escolhido
anopretendido String Ano do veículo escolhido
valorcarro Número (XXXX.XX ou X.XXX,XX) Valor do veículo escolhido
entrada Número (XXXX.XX ou X.XXX,XX) Entrada do veículo escolhido
qtdeparcelas Inteiro Quantidade de parcelas do veículo escolhido
parcela Número (XXXX.XX ou X.XXX,XX) Valor de parcela do veículo escolhido
horario_contato Hora (HH) Melhor horário de contato
troca_placa String Placa do veículo informado para troca
troca_tipo Options:
1 - Carro
2 - Moto
3 - Caminhão
(Padrão: 1)
Tipo do veículo informado para troca
troca_marca String Maca do veículo informado para troca
troca_modelo String Modelo do veículo informado para troca
troca_ano String Ano do veículo informado para troca
troca_valor Número (XXXX.XX ou X.XXX,XX) Valor do veículo informado para troca
troca_pago Número (XXXX.XX ou X.XXX,XX) Valor pago ao veículo informado para troca
troca_km Inteiro KM do veículo informado para troca
troca_debito Número (XXXX.XX ou X.XXX,XX) Valor total de debítos do veículo informado para troca
formapagamento Options:
0 - À Vista
1 - Financiado Banco
2 - Carnê Loja
3 - Compra Programada
(Padrão: 0)
Forma de pagamento do veículo escolhido
negativado Options:
0 - Não
1 - Sim
(Padrão: 0)
Informativo caso o cliente seja negativado
tipo Options:
1 - Comprar
2 - Trocar
3 - Vender
4 - Locação
5 - Informações
6 - Outros
(Padrão: 1)
Tipo de atendimento
origem * Hash Hash de origem para o atendimento
oportunidade Bool (true ou 1, false ou 0) Caso o cliente seja oportunidade
usuario Inteiro Código do usuário que receberá esse lead (Apenas funciona caso não tenha sido selecionado na origem)
ref String Informação de referência de onde veio o cadastro
url String URL de origem do lead
origem_add String Texto que será incluido no final da linha de origem
observacao String Observação a ser inserida no CRM

update

Atualização de cadastro do cliente
https://api.crmtony.com.br/v3/Clients/update

Coming Soon

Coming Soon

                                                import requests

url = Clients/update
querystring = cliente_token=Hash
                                                # Clique aqui para visualizar o SDK
$.CRMTony('Clients/update', { "cliente_token": "Hash" }, { "nome": "String", "cpf": "CPF (XXXX.XXXX.XXXX-XX)", "rg": "String", "nascimento": "Data (YYYY-MM-DD ou DD\/MM\/YYYY)", "cidade": "String", "email": "String", "telefone": "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)", "celular": "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)", "whatsapp": "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)", "0km": "Options", "placapretendida": "String", "carropretendido": "String", "anopretendido": "String", "valorcarro": "Número (XXXX.XX ou X.XXX,XX)", "entrada": "Número (XXXX.XX ou X.XXX,XX)", "qtdeparcelas": "Inteiro", "parcela": "Número (XXXX.XX ou X.XXX,XX)", "horario_contato": "Hora (HH)", "troca_placa": "String", "troca_tipo": "Options", "troca_marca": "String", "troca_modelo": "String", "troca_ano": "String", "troca_valor": "Número (XXXX.XX ou X.XXX,XX)", "troca_pago": "Número (XXXX.XX ou X.XXX,XX)", "troca_km": "Inteiro", "troca_debito": "Número (XXXX.XX ou X.XXX,XX)", "formapagamento": "Options", "negativado": "Options", "tipo": "Options", "oportunidade": "Bool (true ou 1, false ou 0)", "origem_add": "String", "observacao": "String" }, function(successData){
console.log(successData);
}, function(errorData){
console.log(errorData);
});
                                                # Clique aqui para visualizar o SDK
$crmtony = new CRMTony();
$data = $crmtony->run('Clients/update', [
    "cliente_token" => "Hash",
], [
    "nome" => "String",
    "cpf" => "CPF (XXXX.XXXX.XXXX-XX)",
    "rg" => "String",
    "nascimento" => "Data (YYYY-MM-DD ou DD/MM/YYYY)",
    "cidade" => "String",
    "email" => "String",
    "telefone" => "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)",
    "celular" => "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)",
    "whatsapp" => "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)",
    "0km" => "Options",
    "placapretendida" => "String",
    "carropretendido" => "String",
    "anopretendido" => "String",
    "valorcarro" => "Número (XXXX.XX ou X.XXX,XX)",
    "entrada" => "Número (XXXX.XX ou X.XXX,XX)",
    "qtdeparcelas" => "Inteiro",
    "parcela" => "Número (XXXX.XX ou X.XXX,XX)",
    "horario_contato" => "Hora (HH)",
    "troca_placa" => "String",
    "troca_tipo" => "Options",
    "troca_marca" => "String",
    "troca_modelo" => "String",
    "troca_ano" => "String",
    "troca_valor" => "Número (XXXX.XX ou X.XXX,XX)",
    "troca_pago" => "Número (XXXX.XX ou X.XXX,XX)",
    "troca_km" => "Inteiro",
    "troca_debito" => "Número (XXXX.XX ou X.XXX,XX)",
    "formapagamento" => "Options",
    "negativado" => "Options",
    "tipo" => "Options",
    "oportunidade" => "Bool (true ou 1, false ou 0)",
    "origem_add" => "String",
    "observacao" => "String",
]);

echo json_encode($data);
                                                {
    "mensagem": "Cliente atualizado com sucesso",
    "origem": "Hash de origem"
}
                                            
                                                {
    "mensagem": "Cliente não encontrado"
}
                                            
                                                {
    "mensagem": "Erro ao atualizar cliente",
    "error": "N/A"
}
                                            

GET PARAMETERS

Field Type Description
cliente_token * Hash Token criado ao criar um novo cliente, utilizado para identificar o cliente

BODY PARAMETERS

Field Type Description
nome String Nome completo
cpf CPF (XXXX.XXXX.XXXX-XX) CPF
rg String RG
nascimento Data (YYYY-MM-DD ou DD/MM/YYYY) Data de nascimento
cidade String Cidade
email String E-mail
telefone Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999) Telefone
celular Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999) Celular
whatsapp Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999) WhatsApp
0km Options:
0 - Não
1 - Sim
(Padrão: 0)
Informa se o veículo escolhido é 0 Km
placapretendida String Placa do veículo escolhido
carropretendido String Descrição do veículo escolhido
anopretendido String Ano do veículo escolhido
valorcarro Número (XXXX.XX ou X.XXX,XX) Valor do veículo escolhido
entrada Número (XXXX.XX ou X.XXX,XX) Entrada do veículo escolhido
qtdeparcelas Inteiro Quantidade de parcelas do veículo escolhido
parcela Número (XXXX.XX ou X.XXX,XX) Valor de parcela do veículo escolhido
horario_contato Hora (HH) Melhor horário de contato
troca_placa String Placa do veículo informado para troca
troca_tipo Options:
1 - Carro
2 - Moto
3 - Caminhão
Tipo do veículo informado para troca
troca_marca String Maca do veículo informado para troca
troca_modelo String Modelo do veículo informado para troca
troca_ano String Ano do veículo informado para troca
troca_valor Número (XXXX.XX ou X.XXX,XX) Valor do veículo informado para troca
troca_pago Número (XXXX.XX ou X.XXX,XX) Valor pago ao veículo informado para troca
troca_km Inteiro KM do veículo informado para troca
troca_debito Número (XXXX.XX ou X.XXX,XX) Valor total de debítos do veículo informado para troca
formapagamento Options:
0 - À Vista
1 - Financiado Banco
2 - Carnê Loja
3 - Compra Programada
(Padrão: 0)
Forma de pagamento do veículo escolhido
negativado Options:
0 - Não
1 - Sim
Informativo caso o cliente seja negativado
tipo Options:
1 - Comprar
2 - Trocar
3 - Vender
4 - Locação
5 - Informações
6 - Outros
(Padrão: 1)
Tipo de atendimento
oportunidade Bool (true ou 1, false ou 0) Caso o cliente seja oportunidade
origem_add String Texto que será incluido no final da linha de origem
observacao String Observação a ser inserida no CRM

Agendamento

create

Atualização de cadastro do cliente
https://api.crmtony.com.br/v3/Clients/Scheduler/create

Coming Soon

Coming Soon

                                                    import requests

url = Clients/Scheduler/update
querystring = cliente_token=Hash
                                                    # Clique aqui para visualizar o SDK
$.CRMTony('Clients/Scheduler/update', { "cliente_token": "Hash" }, { "usuario": "Inteiro", "data": "Data (YYYY-MM-DD)", "hora": "Hora (HH:MM)", "descricao": "String" }, function(successData){
console.log(successData);
}, function(errorData){
console.log(errorData);
});
                                                    # Clique aqui para visualizar o SDK
$crmtony = new CRMTony();
$data = $crmtony->run('Clients/Scheduler/update', [
    "cliente_token" => "Hash",
], [
    "usuario" => "Inteiro",
    "data" => "Data (YYYY-MM-DD)",
    "hora" => "Hora (HH:MM)",
    "descricao" => "String",
]);

echo json_encode($data);
                                                    {
    "mensagem": "Agendamento criado com sucesso",
    "agendamento_token": "2a45ec25d20da25861d6d6f578d4943a"
}
                                                
                                                    {
    "mensagem": "Cliente não encontrado"
}
                                                
                                                    {
    "mensagem": "Erro ao criar um agendamento para o cliente",
    "error": "N/A"
}
                                                

GET PARAMETERS

Field Type Description
cliente_token * Hash Token criado ao criar um novo cliente, utilizado para identificar o cliente

BODY PARAMETERS

Field Type Description
usuario * Inteiro Código do usuário que receberá o agendamento
data * Data (YYYY-MM-DD) Data de agendamento
hora * Hora (HH:MM) Horário de agendamento
descricao String Descrição para o agendamento

check

Conclui um agendamento
https://api.crmtony.com.br/v3/Clients/Scheduler/check

Coming Soon

Coming Soon

                                                    import requests

url = Clients/Scheduler/update
querystring = agendamento_token=Hash
                                                    # Clique aqui para visualizar o SDK
$.CRMTony('Clients/Scheduler/update', { "agendamento_token": "Hash" }, [], function(successData){
console.log(successData);
}, function(errorData){
console.log(errorData);
});
                                                    # Clique aqui para visualizar o SDK
$crmtony = new CRMTony();
$data = $crmtony->run('Clients/Scheduler/update', [
    "agendamento_token" => "Hash",
], []);

echo json_encode($data);
                                                    {
    "mensagem": "Agendamento concluído com sucesso"
}
                                                
                                                    {
    "mensagem": "Agendamento não encontrado"
}
                                                
                                                    {
    "mensagem": "Erro ao concluir agendamento do cliente",
    "error": "N/A"
}
                                                

GET PARAMETERS

Field Type Description
agendamento_token * Hash Token criado ao criar um novo agendamento, utilizado para identificar o agendamento (Obrigatório caso não envie o cliente_token)

cancel

Cancela um agendamento
https://api.crmtony.com.br/v3/Clients/Scheduler/cancel

Coming Soon

Coming Soon

                                                    import requests

url = Clients/Scheduler/update
querystring = agendamento_token=Hash
                                                    # Clique aqui para visualizar o SDK
$.CRMTony('Clients/Scheduler/update', { "agendamento_token": "Hash" }, [], function(successData){
console.log(successData);
}, function(errorData){
console.log(errorData);
});
                                                    # Clique aqui para visualizar o SDK
$crmtony = new CRMTony();
$data = $crmtony->run('Clients/Scheduler/update', [
    "agendamento_token" => "Hash",
], []);

echo json_encode($data);
                                                    {
    "mensagem": "Agendamento cancelado com sucesso"
}
                                                
                                                    {
    "mensagem": "Agendamento não encontrado"
}
                                                
                                                    {
    "mensagem": "Erro ao cancelar agendamento do cliente",
    "error": "N/A"
}
                                                

GET PARAMETERS

Field Type Description
agendamento_token * Hash Token criado ao criar um novo agendamento, utilizado para identificar o agendamento (Obrigatório caso não envie o cliente_token)

Ficha cadastral

create

Criação de ficha cadastral de um cliente
https://api.crmtony.com.br/v3/Clients/Form/create

Coming Soon

Coming Soon

                                                    import requests

url = Clients/Form/update
querystring = cliente_token=Hash&ficha_token=Hash
                                                    # Clique aqui para visualizar o SDK
$.CRMTony('Clients/Form/update', { "cliente_token": "Hash", "ficha_token": "Hash" }, { "negativado": "Bool (true ou 1, false ou 0)", "pessoal_nomecompleto": "String", "pessoal_email": "String", "pessoal_datanascimento": "Data (YYYY-MM-DD ou DD\/MM\/YYYY)", "pessoal_cpf": "CPF (XXXX.XXXX.XXXX-XX)", "pessoal_rg": "String", "pessoal_sexo": "String", "pessoal_estadocivil": "String", "pessoal_naturalidade": "String", "pessoal_naturalidadeuf": "String", "pessoal_celular": "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)", "pessoal_whatsapp": "String", "pessoal_nomemae": "String", "pessoal_nomepai": "String", "pessoal_cnh": "String", "conjuge_negativado": "Bool (true ou 1, false ou 0)", "conjuge_nomecompleto": "String", "conjuge_datanascimento": "Data (YYYY-MM-DD ou DD\/MM\/YYYY)", "conjuge_cpf": "CPF (XXXX.XXXX.XXXX-XX)", "conjuge_rg": "String", "conjuge_pessoaltelefone": "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)", "conjuge_mae": "String", "conjuge_pai": "String", "conjuge_renda": "Número (XXXX.XX ou X.XXX,XX)", "conjuge_profissao": "String", "conjuge_empresa": "String", "conjuge_empresatempo": "String", "conjuge_empresaendereco": "String", "pessoal_": "String", "conjuge_empresatelefone": "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)", "residencial_cep": "String", "residencial_endereco": "String", "residencial_numero": "String", "residencial_complemento": "String", "residencial_bairro": "String", "residencial_cidade": "String", "residencial_cidadeuf": "String", "residencial_tempomoradia": "String", "residencial_tiporesidencia": "Options", "profissional_tiporenda": "Options", "profissional_registro": "String", "profissional_telefone": "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)", "profissional_telcontador": "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)", "profissional_cep": "String", "profissional_endereco": "String", "profissional_numero": "String", "profissional_complemento": "String", "profissional_bairro": "String", "profissional_cidade": "String", "profissional_beneficio": "String", "profissional_cargo": "String", "profissional_valormensal": "Número (XXXX.XX ou X.XXX,XX)", "profissional_tempoemprego": "String", "profissional_comprovarenda": "String", "profissional_outrafonte": "Bool (true ou 1, false ou 0)", "profissional_outrafontevalor": "String", "referencia_nome1": "String", "referencia_telefone1": "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)", "referencia_tipo1": "String", "referencia_nome2": "String", "referencia_telefone2": "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)", "referencia_tipo2": "String", "referencia_nome3": "String", "referencia_telefone3": "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)", "referencia_tipo3": "String", "referencia_nome4": "String", "referencia_telefone4": "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)", "referencia_tipo4": "String", "bancario_banco1": "String", "bancario_agencia1": "String", "bancario_conta1": "String", "bancario_telefone1": "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)", "bancario_banco2": "String", "bancario_agencia2": "String", "bancario_conta2": "String", "bancario_telefone2": "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)", "placapretendida": "Placa (XXX-XXXX ou XXXXXXX)", "carropretendido": "String", "anopretendido": "String", "valorcarro": "Número (XXXX.XX ou X.XXX,XX)", "financiamentopretendido": "Número (XXXX.XX ou X.XXX,XX)", "entradapretendida": "String", "vezespretendida": "Inteiro", "parcelapretendida": "Número (XXXX.XX ou X.XXX,XX)", "formaentrada": "String", "troca_placa": "Placa (XXX-XXXX ou XXXXXXX)", "troca_marca": "String", "troca_modelo": "String", "troca_ano": "String", "troca_cor": "String", "troca_cidade": "String", "troca_situacao": "String", "troca_km": "String", "troca_debito": "Número (XXXX.XX ou X.XXX,XX)", "observacao": "String" }, function(successData){
console.log(successData);
}, function(errorData){
console.log(errorData);
});
                                                    # Clique aqui para visualizar o SDK
$crmtony = new CRMTony();
$data = $crmtony->run('Clients/Form/update', [
    "cliente_token" => "Hash",
    "ficha_token" => "Hash",
], [
    "negativado" => "Bool (true ou 1, false ou 0)",
    "pessoal_nomecompleto" => "String",
    "pessoal_email" => "String",
    "pessoal_datanascimento" => "Data (YYYY-MM-DD ou DD/MM/YYYY)",
    "pessoal_cpf" => "CPF (XXXX.XXXX.XXXX-XX)",
    "pessoal_rg" => "String",
    "pessoal_sexo" => "String",
    "pessoal_estadocivil" => "String",
    "pessoal_naturalidade" => "String",
    "pessoal_naturalidadeuf" => "String",
    "pessoal_celular" => "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)",
    "pessoal_whatsapp" => "String",
    "pessoal_nomemae" => "String",
    "pessoal_nomepai" => "String",
    "pessoal_cnh" => "String",
    "conjuge_negativado" => "Bool (true ou 1, false ou 0)",
    "conjuge_nomecompleto" => "String",
    "conjuge_datanascimento" => "Data (YYYY-MM-DD ou DD/MM/YYYY)",
    "conjuge_cpf" => "CPF (XXXX.XXXX.XXXX-XX)",
    "conjuge_rg" => "String",
    "conjuge_pessoaltelefone" => "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)",
    "conjuge_mae" => "String",
    "conjuge_pai" => "String",
    "conjuge_renda" => "Número (XXXX.XX ou X.XXX,XX)",
    "conjuge_profissao" => "String",
    "conjuge_empresa" => "String",
    "conjuge_empresatempo" => "String",
    "conjuge_empresaendereco" => "String",
    "pessoal_" => "String",
    "conjuge_empresatelefone" => "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)",
    "residencial_cep" => "String",
    "residencial_endereco" => "String",
    "residencial_numero" => "String",
    "residencial_complemento" => "String",
    "residencial_bairro" => "String",
    "residencial_cidade" => "String",
    "residencial_cidadeuf" => "String",
    "residencial_tempomoradia" => "String",
    "residencial_tiporesidencia" => "Options",
    "profissional_tiporenda" => "Options",
    "profissional_registro" => "String",
    "profissional_telefone" => "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)",
    "profissional_telcontador" => "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)",
    "profissional_cep" => "String",
    "profissional_endereco" => "String",
    "profissional_numero" => "String",
    "profissional_complemento" => "String",
    "profissional_bairro" => "String",
    "profissional_cidade" => "String",
    "profissional_beneficio" => "String",
    "profissional_cargo" => "String",
    "profissional_valormensal" => "Número (XXXX.XX ou X.XXX,XX)",
    "profissional_tempoemprego" => "String",
    "profissional_comprovarenda" => "String",
    "profissional_outrafonte" => "Bool (true ou 1, false ou 0)",
    "profissional_outrafontevalor" => "String",
    "referencia_nome1" => "String",
    "referencia_telefone1" => "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)",
    "referencia_tipo1" => "String",
    "referencia_nome2" => "String",
    "referencia_telefone2" => "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)",
    "referencia_tipo2" => "String",
    "referencia_nome3" => "String",
    "referencia_telefone3" => "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)",
    "referencia_tipo3" => "String",
    "referencia_nome4" => "String",
    "referencia_telefone4" => "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)",
    "referencia_tipo4" => "String",
    "bancario_banco1" => "String",
    "bancario_agencia1" => "String",
    "bancario_conta1" => "String",
    "bancario_telefone1" => "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)",
    "bancario_banco2" => "String",
    "bancario_agencia2" => "String",
    "bancario_conta2" => "String",
    "bancario_telefone2" => "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)",
    "placapretendida" => "Placa (XXX-XXXX ou XXXXXXX)",
    "carropretendido" => "String",
    "anopretendido" => "String",
    "valorcarro" => "Número (XXXX.XX ou X.XXX,XX)",
    "financiamentopretendido" => "Número (XXXX.XX ou X.XXX,XX)",
    "entradapretendida" => "String",
    "vezespretendida" => "Inteiro",
    "parcelapretendida" => "Número (XXXX.XX ou X.XXX,XX)",
    "formaentrada" => "String",
    "troca_placa" => "Placa (XXX-XXXX ou XXXXXXX)",
    "troca_marca" => "String",
    "troca_modelo" => "String",
    "troca_ano" => "String",
    "troca_cor" => "String",
    "troca_cidade" => "String",
    "troca_situacao" => "String",
    "troca_km" => "String",
    "troca_debito" => "Número (XXXX.XX ou X.XXX,XX)",
    "observacao" => "String",
]);

echo json_encode($data);
                                                    {
    "mensagem": "Ficha cadastral criada com sucesso",
    "ficha_token": "2a45ec25d20da25861d6d6f578d4943a"
}
                                                
                                                    {
    "mensagem": "Cliente não encontrado"
}
                                                
                                                    {
    "mensagem": "Erro ao criar uma ficha cadastral para o cliente",
    "error": "N/A"
}
                                                

GET PARAMETERS

Field Type Description
cliente_token * Hash Token criado ao criar um novo cliente, utilizado para identificar o cliente
ficha_token Hash Token criado ao criar uma nova ficha, utilizado para identificar a ficha (Caso a ficha já tenha sido analizada, será criada uma nova)

BODY PARAMETERS

Field Type Description
negativado Bool (true ou 1, false ou 0) Negativado
pessoal_nomecompleto String Nome completo
pessoal_email String E-mail pessoal
pessoal_datanascimento Data (YYYY-MM-DD ou DD/MM/YYYY) Data de nascimento
pessoal_cpf CPF (XXXX.XXXX.XXXX-XX) CPF
pessoal_rg String RG
pessoal_sexo String
pessoal_estadocivil String Estado Civil
pessoal_naturalidade String Naturalidade
pessoal_naturalidadeuf String Estado de naturalidade
pessoal_celular Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999) Celular
pessoal_whatsapp String WhatsApp
pessoal_nomemae String Nome da mãe
pessoal_nomepai String Nome do Pai
pessoal_cnh String CNH
conjuge_negativado Bool (true ou 1, false ou 0)
conjuge_nomecompleto String Nome completo do cônjuge
conjuge_datanascimento Data (YYYY-MM-DD ou DD/MM/YYYY) Data de nascimento do cônjuge
conjuge_cpf CPF (XXXX.XXXX.XXXX-XX) CPF do cônjuge
conjuge_rg String RG do cônjuge
conjuge_pessoaltelefone Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999) Telefone pessoal do cônjuge
conjuge_mae String Nome da mãe do cônjuge
conjuge_pai String Nome do pai do cônjuge
conjuge_renda Número (XXXX.XX ou X.XXX,XX) Renda mensal do cônjuge
conjuge_profissao String Profissão do cônjuge
conjuge_empresa String Nome da empresa do cônjuge
conjuge_empresatempo String Tempo de empresa do cônjuge
conjuge_empresaendereco String Endereço da empresa do cônjuge
pessoal_ String do cônjuge
conjuge_empresatelefone Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999) Telefone da empresa do cônjuge
residencial_cep String CEP de residencia
residencial_endereco String Logradouro de residencia
residencial_numero String Número da residencia
residencial_complemento String Complemento da residencia
residencial_bairro String Bairro de residencia
residencial_cidade String Cidade de residencia
residencial_cidadeuf String Estado de residencia
residencial_tempomoradia String Tempo de residencia
residencial_tiporesidencia Options:
0 - Própria
1 - Alugada
Tipo da residencia
profissional_tiporenda Options:
0 - Aposentado
1 - Assalariado
2 - Autônomo
3 - Empresário
4 - Profissional Liberal
Tipo de renda
profissional_registro String CNPJ da empresa caso empresário, ou número de registro caso seja profissional liberal
profissional_telefone Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999) Telefone da empresa
profissional_telcontador Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999) Telefone do contador (apenas em caso de empresário)
profissional_cep String CEP da empresa
profissional_endereco String Logradouro da empresa
profissional_numero String Número da empresa
profissional_complemento String Complemento da empresa
profissional_bairro String Bairro da empresa
profissional_cidade String Cidade da empresa
profissional_beneficio String Número do benefício (apenas para aposentado)
profissional_cargo String Cargo na empresa
profissional_valormensal Número (XXXX.XX ou X.XXX,XX) Renda mensal
profissional_tempoemprego String Tempo de empresa
profissional_comprovarenda String Como comprova renda
profissional_outrafonte Bool (true ou 1, false ou 0) Possuí outra fonte de renda
profissional_outrafontevalor String Valor da outra fonte de renda
referencia_nome1 String Nome de uma referência (Referência 1)
referencia_telefone1 Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999) Telefone da referência (Referência 1)
referencia_tipo1 String Tipo da referencia, exemplo: irmão, noivo, etc. (Referência 1)
referencia_nome2 String Nome de uma referência (Referência 2)
referencia_telefone2 Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999) Telefone da referência (Referência 2)
referencia_tipo2 String Tipo da referencia, exemplo: irmão, noivo, etc. (Referência 2)
referencia_nome3 String Nome de uma referência (Referência 3)
referencia_telefone3 Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999) Telefone da referência (Referência 3)
referencia_tipo3 String Tipo da referencia, exemplo: irmão, noivo, etc. (Referência 3)
referencia_nome4 String Nome de uma referência (Referência 4)
referencia_telefone4 Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999) Telefone da referência (Referência 4)
referencia_tipo4 String Tipo da referencia, exemplo: irmão, noivo, etc. (Referência 4)
bancario_banco1 String Nome do banco (Banco 1)
bancario_agencia1 String Agência do banco (Banco 1)
bancario_conta1 String Conta do banco (Banco 1)
bancario_telefone1 Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999) Telefone do banco (Banco 1)
bancario_banco2 String Nome do banco (Banco 2)
bancario_agencia2 String Agência do banco (Banco 2)
bancario_conta2 String Conta do banco (Banco 2)
bancario_telefone2 Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999) Telefone do banco (Banco 2)
placapretendida Placa (XXX-XXXX ou XXXXXXX) Placa do veículo pretendido
carropretendido String Descrição do veículo pretendido
anopretendido String Ano do veículo pretendido
valorcarro Número (XXXX.XX ou X.XXX,XX) Valor do veículo pretendido
financiamentopretendido Número (XXXX.XX ou X.XXX,XX) Valor que irá financiar do veículo pretendido
entradapretendida String Entrada do veículo pretendido
vezespretendida Inteiro Número de parcelas do veículo pretendido
parcelapretendida Número (XXXX.XX ou X.XXX,XX) Valor da parcela do veículo pretendido
formaentrada String Forma de pagamento da entrada
troca_placa Placa (XXX-XXXX ou XXXXXXX) Placa do veículo de troca
troca_marca String Marca do veículo de troca
troca_modelo String Modelo do veículo de troca
troca_ano String Ano do veículo de troca
troca_cor String Cor do veículo de troca
troca_cidade String Cidade do veículo de troca
troca_situacao String Situação do veículo de troca
troca_km String KM do veículo de troca
troca_debito Número (XXXX.XX ou X.XXX,XX) Soma de débitos do veículo de troca
observacao String Observação generica para a ficha, pode ser usada da forma que preferir

update

Atualização de ficha cadastral de um cliente
https://api.crmtony.com.br/v3/Clients/Form/update

Coming Soon

Coming Soon

                                                    import requests

url = Clients/Form/update
querystring = cliente_token=Hash&ficha_token=Hash
                                                    # Clique aqui para visualizar o SDK
$.CRMTony('Clients/Form/update', { "cliente_token": "Hash", "ficha_token": "Hash" }, { "negativado": "Bool (true ou 1, false ou 0)", "pessoal_nomecompleto": "String", "pessoal_email": "String", "pessoal_datanascimento": "Data (YYYY-MM-DD ou DD\/MM\/YYYY)", "pessoal_cpf": "CPF (XXXX.XXXX.XXXX-XX)", "pessoal_rg": "String", "pessoal_sexo": "String", "pessoal_estadocivil": "String", "pessoal_naturalidade": "String", "pessoal_naturalidadeuf": "String", "pessoal_celular": "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)", "pessoal_whatsapp": "String", "pessoal_nomemae": "String", "pessoal_nomepai": "String", "pessoal_cnh": "String", "conjuge_negativado": "Bool (true ou 1, false ou 0)", "conjuge_nomecompleto": "String", "conjuge_datanascimento": "Data (YYYY-MM-DD ou DD\/MM\/YYYY)", "conjuge_cpf": "CPF (XXXX.XXXX.XXXX-XX)", "conjuge_rg": "String", "conjuge_pessoaltelefone": "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)", "conjuge_mae": "String", "conjuge_pai": "String", "conjuge_renda": "Número (XXXX.XX ou X.XXX,XX)", "conjuge_profissao": "String", "conjuge_empresa": "String", "conjuge_empresatempo": "String", "conjuge_empresaendereco": "String", "pessoal_": "String", "conjuge_empresatelefone": "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)", "residencial_cep": "String", "residencial_endereco": "String", "residencial_numero": "String", "residencial_complemento": "String", "residencial_bairro": "String", "residencial_cidade": "String", "residencial_cidadeuf": "String", "residencial_tempomoradia": "String", "residencial_tiporesidencia": "Options", "profissional_tiporenda": "Options", "profissional_registro": "String", "profissional_telefone": "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)", "profissional_telcontador": "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)", "profissional_cep": "String", "profissional_endereco": "String", "profissional_numero": "String", "profissional_complemento": "String", "profissional_bairro": "String", "profissional_cidade": "String", "profissional_beneficio": "String", "profissional_cargo": "String", "profissional_valormensal": "Número (XXXX.XX ou X.XXX,XX)", "profissional_tempoemprego": "String", "profissional_comprovarenda": "String", "profissional_outrafonte": "Bool (true ou 1, false ou 0)", "profissional_outrafontevalor": "String", "referencia_nome1": "String", "referencia_telefone1": "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)", "referencia_tipo1": "String", "referencia_nome2": "String", "referencia_telefone2": "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)", "referencia_tipo2": "String", "referencia_nome3": "String", "referencia_telefone3": "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)", "referencia_tipo3": "String", "referencia_nome4": "String", "referencia_telefone4": "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)", "referencia_tipo4": "String", "bancario_banco1": "String", "bancario_agencia1": "String", "bancario_conta1": "String", "bancario_telefone1": "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)", "bancario_banco2": "String", "bancario_agencia2": "String", "bancario_conta2": "String", "bancario_telefone2": "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)", "placapretendida": "Placa (XXX-XXXX ou XXXXXXX)", "carropretendido": "String", "anopretendido": "String", "valorcarro": "Número (XXXX.XX ou X.XXX,XX)", "financiamentopretendido": "Número (XXXX.XX ou X.XXX,XX)", "entradapretendida": "String", "vezespretendida": "Inteiro", "parcelapretendida": "Número (XXXX.XX ou X.XXX,XX)", "formaentrada": "String", "troca_placa": "Placa (XXX-XXXX ou XXXXXXX)", "troca_marca": "String", "troca_modelo": "String", "troca_ano": "String", "troca_cor": "String", "troca_cidade": "String", "troca_situacao": "String", "troca_km": "String", "troca_debito": "Número (XXXX.XX ou X.XXX,XX)", "observacao": "String" }, function(successData){
console.log(successData);
}, function(errorData){
console.log(errorData);
});
                                                    # Clique aqui para visualizar o SDK
$crmtony = new CRMTony();
$data = $crmtony->run('Clients/Form/update', [
    "cliente_token" => "Hash",
    "ficha_token" => "Hash",
], [
    "negativado" => "Bool (true ou 1, false ou 0)",
    "pessoal_nomecompleto" => "String",
    "pessoal_email" => "String",
    "pessoal_datanascimento" => "Data (YYYY-MM-DD ou DD/MM/YYYY)",
    "pessoal_cpf" => "CPF (XXXX.XXXX.XXXX-XX)",
    "pessoal_rg" => "String",
    "pessoal_sexo" => "String",
    "pessoal_estadocivil" => "String",
    "pessoal_naturalidade" => "String",
    "pessoal_naturalidadeuf" => "String",
    "pessoal_celular" => "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)",
    "pessoal_whatsapp" => "String",
    "pessoal_nomemae" => "String",
    "pessoal_nomepai" => "String",
    "pessoal_cnh" => "String",
    "conjuge_negativado" => "Bool (true ou 1, false ou 0)",
    "conjuge_nomecompleto" => "String",
    "conjuge_datanascimento" => "Data (YYYY-MM-DD ou DD/MM/YYYY)",
    "conjuge_cpf" => "CPF (XXXX.XXXX.XXXX-XX)",
    "conjuge_rg" => "String",
    "conjuge_pessoaltelefone" => "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)",
    "conjuge_mae" => "String",
    "conjuge_pai" => "String",
    "conjuge_renda" => "Número (XXXX.XX ou X.XXX,XX)",
    "conjuge_profissao" => "String",
    "conjuge_empresa" => "String",
    "conjuge_empresatempo" => "String",
    "conjuge_empresaendereco" => "String",
    "pessoal_" => "String",
    "conjuge_empresatelefone" => "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)",
    "residencial_cep" => "String",
    "residencial_endereco" => "String",
    "residencial_numero" => "String",
    "residencial_complemento" => "String",
    "residencial_bairro" => "String",
    "residencial_cidade" => "String",
    "residencial_cidadeuf" => "String",
    "residencial_tempomoradia" => "String",
    "residencial_tiporesidencia" => "Options",
    "profissional_tiporenda" => "Options",
    "profissional_registro" => "String",
    "profissional_telefone" => "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)",
    "profissional_telcontador" => "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)",
    "profissional_cep" => "String",
    "profissional_endereco" => "String",
    "profissional_numero" => "String",
    "profissional_complemento" => "String",
    "profissional_bairro" => "String",
    "profissional_cidade" => "String",
    "profissional_beneficio" => "String",
    "profissional_cargo" => "String",
    "profissional_valormensal" => "Número (XXXX.XX ou X.XXX,XX)",
    "profissional_tempoemprego" => "String",
    "profissional_comprovarenda" => "String",
    "profissional_outrafonte" => "Bool (true ou 1, false ou 0)",
    "profissional_outrafontevalor" => "String",
    "referencia_nome1" => "String",
    "referencia_telefone1" => "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)",
    "referencia_tipo1" => "String",
    "referencia_nome2" => "String",
    "referencia_telefone2" => "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)",
    "referencia_tipo2" => "String",
    "referencia_nome3" => "String",
    "referencia_telefone3" => "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)",
    "referencia_tipo3" => "String",
    "referencia_nome4" => "String",
    "referencia_telefone4" => "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)",
    "referencia_tipo4" => "String",
    "bancario_banco1" => "String",
    "bancario_agencia1" => "String",
    "bancario_conta1" => "String",
    "bancario_telefone1" => "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)",
    "bancario_banco2" => "String",
    "bancario_agencia2" => "String",
    "bancario_conta2" => "String",
    "bancario_telefone2" => "Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999)",
    "placapretendida" => "Placa (XXX-XXXX ou XXXXXXX)",
    "carropretendido" => "String",
    "anopretendido" => "String",
    "valorcarro" => "Número (XXXX.XX ou X.XXX,XX)",
    "financiamentopretendido" => "Número (XXXX.XX ou X.XXX,XX)",
    "entradapretendida" => "String",
    "vezespretendida" => "Inteiro",
    "parcelapretendida" => "Número (XXXX.XX ou X.XXX,XX)",
    "formaentrada" => "String",
    "troca_placa" => "Placa (XXX-XXXX ou XXXXXXX)",
    "troca_marca" => "String",
    "troca_modelo" => "String",
    "troca_ano" => "String",
    "troca_cor" => "String",
    "troca_cidade" => "String",
    "troca_situacao" => "String",
    "troca_km" => "String",
    "troca_debito" => "Número (XXXX.XX ou X.XXX,XX)",
    "observacao" => "String",
]);

echo json_encode($data);
                                                    {
    "mensagem": "Ficha cadastral criada com sucesso",
    "ficha_token": "2a45ec25d20da25861d6d6f578d4943a"
}
                                                
                                                    {
    "mensagem": "Cliente não encontrado"
}
                                                
                                                    {
    "mensagem": "Erro ao criar uma ficha cadastral para o cliente",
    "error": "N/A"
}
                                                

GET PARAMETERS

Field Type Description
cliente_token * Hash Token criado ao criar um novo cliente, utilizado para identificar o cliente
ficha_token * Hash Token criado ao criar uma nova ficha, utilizado para identificar a ficha (Caso a ficha já tenha sido analizada, será criada uma nova)

BODY PARAMETERS

Field Type Description
negativado Bool (true ou 1, false ou 0) Negativado
pessoal_nomecompleto String Nome completo
pessoal_email String E-mail pessoal
pessoal_datanascimento Data (YYYY-MM-DD ou DD/MM/YYYY) Data de nascimento
pessoal_cpf CPF (XXXX.XXXX.XXXX-XX) CPF
pessoal_rg String RG
pessoal_sexo String
pessoal_estadocivil String Estado Civil
pessoal_naturalidade String Naturalidade
pessoal_naturalidadeuf String Estado de naturalidade
pessoal_celular Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999) Celular
pessoal_whatsapp String WhatsApp
pessoal_nomemae String Nome da mãe
pessoal_nomepai String Nome do Pai
pessoal_cnh String CNH
conjuge_negativado Bool (true ou 1, false ou 0)
conjuge_nomecompleto String Nome completo do cônjuge
conjuge_datanascimento Data (YYYY-MM-DD ou DD/MM/YYYY) Data de nascimento do cônjuge
conjuge_cpf CPF (XXXX.XXXX.XXXX-XX) CPF do cônjuge
conjuge_rg String RG do cônjuge
conjuge_pessoaltelefone Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999) Telefone pessoal do cônjuge
conjuge_mae String Nome da mãe do cônjuge
conjuge_pai String Nome do pai do cônjuge
conjuge_renda Número (XXXX.XX ou X.XXX,XX) Renda mensal do cônjuge
conjuge_profissao String Profissão do cônjuge
conjuge_empresa String Nome da empresa do cônjuge
conjuge_empresatempo String Tempo de empresa do cônjuge
conjuge_empresaendereco String Endereço da empresa do cônjuge
pessoal_ String do cônjuge
conjuge_empresatelefone Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999) Telefone da empresa do cônjuge
residencial_cep String CEP de residencia
residencial_endereco String Logradouro de residencia
residencial_numero String Número da residencia
residencial_complemento String Complemento da residencia
residencial_bairro String Bairro de residencia
residencial_cidade String Cidade de residencia
residencial_cidadeuf String Estado de residencia
residencial_tempomoradia String Tempo de residencia
residencial_tiporesidencia Options:
0 - Própria
1 - Alugada
Tipo da residencia
profissional_tiporenda Options:
0 - Aposentado
1 - Assalariado
2 - Autônomo
3 - Empresário
4 - Profissional Liberal
Tipo de renda
profissional_registro String CNPJ da empresa caso empresário, ou número de registro caso seja profissional liberal
profissional_telefone Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999) Telefone da empresa
profissional_telcontador Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999) Telefone do contador (apenas em caso de empresário)
profissional_cep String CEP da empresa
profissional_endereco String Logradouro da empresa
profissional_numero String Número da empresa
profissional_complemento String Complemento da empresa
profissional_bairro String Bairro da empresa
profissional_cidade String Cidade da empresa
profissional_beneficio String Número do benefício (apenas para aposentado)
profissional_cargo String Cargo na empresa
profissional_valormensal Número (XXXX.XX ou X.XXX,XX) Renda mensal
profissional_tempoemprego String Tempo de empresa
profissional_comprovarenda String Como comprova renda
profissional_outrafonte Bool (true ou 1, false ou 0) Possuí outra fonte de renda
profissional_outrafontevalor String Valor da outra fonte de renda
referencia_nome1 String Nome de uma referência (Referência 1)
referencia_telefone1 Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999) Telefone da referência (Referência 1)
referencia_tipo1 String Tipo da referencia, exemplo: irmão, noivo, etc. (Referência 1)
referencia_nome2 String Nome de uma referência (Referência 2)
referencia_telefone2 Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999) Telefone da referência (Referência 2)
referencia_tipo2 String Tipo da referencia, exemplo: irmão, noivo, etc. (Referência 2)
referencia_nome3 String Nome de uma referência (Referência 3)
referencia_telefone3 Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999) Telefone da referência (Referência 3)
referencia_tipo3 String Tipo da referencia, exemplo: irmão, noivo, etc. (Referência 3)
referencia_nome4 String Nome de uma referência (Referência 4)
referencia_telefone4 Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999) Telefone da referência (Referência 4)
referencia_tipo4 String Tipo da referencia, exemplo: irmão, noivo, etc. (Referência 4)
bancario_banco1 String Nome do banco (Banco 1)
bancario_agencia1 String Agência do banco (Banco 1)
bancario_conta1 String Conta do banco (Banco 1)
bancario_telefone1 Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999) Telefone do banco (Banco 1)
bancario_banco2 String Nome do banco (Banco 2)
bancario_agencia2 String Agência do banco (Banco 2)
bancario_conta2 String Conta do banco (Banco 2)
bancario_telefone2 Telefone (55 (11) 99999-9999 ou (11) 99999-9999 ou 11999999999) Telefone do banco (Banco 2)
placapretendida Placa (XXX-XXXX ou XXXXXXX) Placa do veículo pretendido
carropretendido String Descrição do veículo pretendido
anopretendido String Ano do veículo pretendido
valorcarro Número (XXXX.XX ou X.XXX,XX) Valor do veículo pretendido
financiamentopretendido Número (XXXX.XX ou X.XXX,XX) Valor que irá financiar do veículo pretendido
entradapretendida String Entrada do veículo pretendido
vezespretendida Inteiro Número de parcelas do veículo pretendido
parcelapretendida Número (XXXX.XX ou X.XXX,XX) Valor da parcela do veículo pretendido
formaentrada String Forma de pagamento da entrada
troca_placa Placa (XXX-XXXX ou XXXXXXX) Placa do veículo de troca
troca_marca String Marca do veículo de troca
troca_modelo String Modelo do veículo de troca
troca_ano String Ano do veículo de troca
troca_cor String Cor do veículo de troca
troca_cidade String Cidade do veículo de troca
troca_situacao String Situação do veículo de troca
troca_km String KM do veículo de troca
troca_debito Número (XXXX.XX ou X.XXX,XX) Soma de débitos do veículo de troca
observacao String Observação generica para a ficha, pode ser usada da forma que preferir

Documentos

upload

Upload de documentos
https://api.crmtony.com.br/v3/Clients/Documents/upload

Coming Soon

Coming Soon

                                                    import requests

url = Clients/Documents/update
querystring = cliente_token=Hash
                                                    # Clique aqui para visualizar o SDK
$.CRMTony('Clients/Documents/update', { "cliente_token": "Hash" }, [], function(successData){
console.log(successData);
}, function(errorData){
console.log(errorData);
});
                                                    # Clique aqui para visualizar o SDK
$crmtony = new CRMTony();
$data = $crmtony->run('Clients/Documents/update', [
    "cliente_token" => "Hash",
], []);

echo json_encode($data);
                                                    [
    {
        "name": "file.png",
        "url": "https://url.com/file.png"
    }
]
                                                
                                                    {
    "mensagem": "Cliente não encontrado"
}
                                                
                                                    {
    "mensagem": "Erro ao criar um agendamento para o cliente",
    "error": "N/A"
}
                                                

GET PARAMETERS

Field Type Description
cliente_token * Hash Token criado ao criar um novo cliente, utilizado para identificar o cliente

FILES PARAMETERS

Field Type Description
files * Array de arquivos [ name|int => file_object ] Array de arquivos

Precificador

Precificador de veículo

store

Buscar preço de compra loja
https://api.crmtony.com.br/v3/Pricing/store

Coming Soon

Coming Soon

                                                import requests

url = Pricing/store
querystring = cliente_token=Hash
                                                # Clique aqui para visualizar o SDK
$.CRMTony('Pricing/store', { "cliente_token": "Hash" }, { "uf": "String", "tipo": "Options", "marca": "String", "modelo": "String", "versao": "String", "ano": "Ano (YYYY)", "km": "Inteiro" }, function(successData){
console.log(successData);
}, function(errorData){
console.log(errorData);
});
                                                # Clique aqui para visualizar o SDK
$crmtony = new CRMTony();
$data = $crmtony->run('Pricing/store', [
    "cliente_token" => "Hash",
], [
    "uf" => "String",
    "tipo" => "Options",
    "marca" => "String",
    "modelo" => "String",
    "versao" => "String",
    "ano" => "Ano (YYYY)",
    "km" => "Inteiro",
]);

echo json_encode($data);
                                                {
    "min": 0,
    "max": 0
}
                                            
                                                {
    "mensagem": "Cliente atualizado com sucesso",
    "min": 0,
    "max": 0
}
                                            
                                                {
    "mensagem": "Erro ao atualizar cliente",
    "min": 0,
    "max": 0
}
                                            

GET PARAMETERS

Field Type Description
cliente_token Hash Token criado ao criar um novo cliente, utilizado para identificar o cliente

BODY PARAMETERS

Field Type Description
uf String Estado para cotação do veículo
tipo Options:
1 - Carro
2 - Moto
3 - Caminhão
(Padrão: 1)
Tipo do veículo
marca * String Marca do veículo
modelo * String Modelo do veículo
versao * String Versão do veículo
ano * Ano (YYYY) Ano do veículo
km * Inteiro KM do veículo

match

Busca lista de possíveis coincidencias da placa em relação a FIPE
https://api.crmtony.com.br/v3/Pricing/match

Coming Soon

Coming Soon

                                                import requests

url = Pricing/match
querystring = placa=Placa+%28XXX-XXXX+ou+XXXXXXX%29&match_token=Hash&match=Inteiro
                                                # Clique aqui para visualizar o SDK
$.CRMTony('Pricing/match', { "placa": "Placa (XXX-XXXX ou XXXXXXX)", "match_token": "Hash", "match": "Inteiro" }, [], function(successData){
console.log(successData);
}, function(errorData){
console.log(errorData);
});
                                                # Clique aqui para visualizar o SDK
$crmtony = new CRMTony();
$data = $crmtony->run('Pricing/match', [
    "placa" => "Placa (XXX-XXXX ou XXXXXXX)",
    "match_token" => "Hash",
    "match" => "Inteiro",
], []);

echo json_encode($data);
                                                "Array"
                                            
                                                {
    "mensagem": "Cliente atualizado com sucesso",
    "min": 0,
    "max": 0
}
                                            
                                                {
    "mensagem": "Erro ao atualizar cliente",
    "min": 0,
    "max": 0
}
                                            

GET PARAMETERS

Field Type Description
placa * Placa (XXX-XXXX ou XXXXXXX) Placa do veículo
match_token Hash Token de autenticação para atualizar a FIPE
match Inteiro Index de versão para marcar a placa com o código FIPE

Calculadora

simulate


https://api.crmtony.com.br/v3/Pricing/Calc/simulate

Coming Soon

Coming Soon

                                                    import requests

url = Pricing/Calc/match
querystring = negativado=Bool+%28true+ou+1%2C+false+ou+0%29&valor=N%C3%BAmero+%28XXXX.XX+ou+X.XXX%2CXX%29&entrada=N%C3%BAmero+%28XXXX.XX+ou+X.XXX%2CXX%29
                                                    # Clique aqui para visualizar o SDK
$.CRMTony('Pricing/Calc/match', { "negativado": "Bool (true ou 1, false ou 0)", "valor": "Número (XXXX.XX ou X.XXX,XX)", "entrada": "Número (XXXX.XX ou X.XXX,XX)" }, [], function(successData){
console.log(successData);
}, function(errorData){
console.log(errorData);
});
                                                    # Clique aqui para visualizar o SDK
$crmtony = new CRMTony();
$data = $crmtony->run('Pricing/Calc/match', [
    "negativado" => "Bool (true ou 1, false ou 0)",
    "valor" => "Número (XXXX.XX ou X.XXX,XX)",
    "entrada" => "Número (XXXX.XX ou X.XXX,XX)",
], []);

echo json_encode($data);

GET PARAMETERS

Field Type Description
negativado Bool (true ou 1, false ou 0) Negativado
valor * Número (XXXX.XX ou X.XXX,XX) Valor do veículo
entrada * Número (XXXX.XX ou X.XXX,XX) Entrada do veículo

BODY PARAMETERS

Field Type Description

Crédito

simulate


https://api.crmtony.com.br/v3/Pricing/Credit/simulate

Coming Soon

Coming Soon

                                                    import requests

url = Pricing/Credit/match
querystring = cliente_token=Hash
                                                    # Clique aqui para visualizar o SDK
$.CRMTony('Pricing/Credit/match', { "cliente_token": "Hash" }, { "negativado": "Options", "valor_veiculo": "Número (XXXX.XX ou X.XXX,XX)", "qtde_parcelas": "Options", "entrada_veiculo": "Número (XXXX.XX ou X.XXX,XX)", "renda_tipo": "Options", "renda_valor": "Número (XXXX.XX ou X.XXX,XX)", "renda_auxiliar": "Options", "tempo_trabalho": "Options", "sexo": "Options", "nascimento": "Data (YYYY-MM-DD)", "moradia_tipo": "Options", "moradia_tempo": "Options", "estado_civil": "Options", "dependentes": "Inteiro", "cliente": "Bool (true ou 1, false ou 0)", "aprovado_pan": "Bool (true ou 1, false ou 0)", "aprovado_santander": "Bool (true ou 1, false ou 0)" }, function(successData){
console.log(successData);
}, function(errorData){
console.log(errorData);
});
                                                    # Clique aqui para visualizar o SDK
$crmtony = new CRMTony();
$data = $crmtony->run('Pricing/Credit/match', [
    "cliente_token" => "Hash",
], [
    "negativado" => "Options",
    "valor_veiculo" => "Número (XXXX.XX ou X.XXX,XX)",
    "qtde_parcelas" => "Options",
    "entrada_veiculo" => "Número (XXXX.XX ou X.XXX,XX)",
    "renda_tipo" => "Options",
    "renda_valor" => "Número (XXXX.XX ou X.XXX,XX)",
    "renda_auxiliar" => "Options",
    "tempo_trabalho" => "Options",
    "sexo" => "Options",
    "nascimento" => "Data (YYYY-MM-DD)",
    "moradia_tipo" => "Options",
    "moradia_tempo" => "Options",
    "estado_civil" => "Options",
    "dependentes" => "Inteiro",
    "cliente" => "Bool (true ou 1, false ou 0)",
    "aprovado_pan" => "Bool (true ou 1, false ou 0)",
    "aprovado_santander" => "Bool (true ou 1, false ou 0)",
]);

echo json_encode($data);
                                                    {
    "analise": {
        "score": 500,
        "status": "Aprovado"
    },
    "parcela": {
        "min": 1000,
        "max": 1000,
        "default": 1000
    }
}
                                                

GET PARAMETERS

Field Type Description
cliente_token Hash Token criado ao criar um novo cliente, utilizado para identificar o cliente

BODY PARAMETERS

Field Type Description
negativado Options:
0 - Não
1 - Sim
(Padrão: 0)
Informativo caso o cliente seja negativado
valor_veiculo * Número (XXXX.XX ou X.XXX,XX) Valor do veículo escolhido
qtde_parcelas * Options:
1 - 12
2 - 24
3 - 36
4 - 48
Quantidade de parcelas
entrada_veiculo * Número (XXXX.XX ou X.XXX,XX) Entrada do veículo escolhido
renda_tipo * Options:
0 - Aposentado
1 - Assalariado
2 - Autônomo
3 - Empresário
4 - Profissional Liberal
5 - Motorista de aplicativo
Tipo de renda
renda_valor * Número (XXXX.XX ou X.XXX,XX) Renda mensal
renda_auxiliar Options:
0 - Cônjuge
1 - Pai
2 - Mãe
3 - Irmão(ã)
4 - Primo(a)
Quem vai auxiliar a pagar
tempo_trabalho * Options:
0 - Menos de 6 meses
1 - Entre 6 meses e 1 ano
2 - Entre 1 e 3 anos
3 - Mais de 4 anos
Tempo de trabalho
sexo Options:
0 - Masculino
1 - Feminino
Qual o sexo
nascimento * Data (YYYY-MM-DD) Data de nascimento
moradia_tipo * Options:
0 - Própria / Quitada
1 - Própria / Parcela compatível com renda
2 - Própria / Parcela não compatível com renda
3 - Alugada / Aluguel compatível com renda
4 - Alugada / Aluguel não compatível com renda
5 - Alugada / Tem contrato de locação
6 - Alugada / Não tem contrato de locação
Quem vai auxiliar a pagar
moradia_tempo Options:
0 - Breve
A quanto tempo mora na residencia
estado_civil * Options:
0 - Solteiro(a)
1 - Casado(a)
2 - Viúvo(a)
3 - Divorciado(a)
Qual o estado civil
dependentes * Inteiro Quantidade de dependentes
cliente Bool (true ou 1, false ou 0) Já é cliente da loja?
aprovado_pan Bool (true ou 1, false ou 0) Já foi aprovado no banco Pan?
aprovado_santander Bool (true ou 1, false ou 0) Já foi aprovado no Santander?

Integrações

Integrações com serviços terceirizados

Geo

cities

Retorna todas as cidades do estado
https://api.crmtony.com.br/v3/Integration/Geo/cities

Coming Soon

Coming Soon

                                                    import requests

url = Integration/Geo/match
querystring =
                                                    # Clique aqui para visualizar o SDK
$.CRMTony('Integration/Geo/match', [], { "estado": "String" }, function(successData){
console.log(successData);
}, function(errorData){
console.log(errorData);
});
                                                    # Clique aqui para visualizar o SDK
$crmtony = new CRMTony();
$data = $crmtony->run('Integration/Geo/match', [], [
    "estado" => "String",
]);

echo json_encode($data);
                                                    {
    "cities": "Array"
}
                                                
                                                    {
    "mensagem": "Nenhuma cidade encontrada"
}
                                                

BODY PARAMETERS

Field Type Description
estado String Nome do estado (Ex.: SP ou São Paulo)

states

Retorna todos estados
https://api.crmtony.com.br/v3/Integration/Geo/states

Coming Soon

Coming Soon

                                                    import requests

url = Integration/Geo/match
querystring =
                                                    # Clique aqui para visualizar o SDK
$.CRMTony('Integration/Geo/match', [], { "estado": "String" }, function(successData){
console.log(successData);
}, function(errorData){
console.log(errorData);
});
                                                    # Clique aqui para visualizar o SDK
$crmtony = new CRMTony();
$data = $crmtony->run('Integration/Geo/match', [], [
    "estado" => "String",
]);

echo json_encode($data);
                                                    {
    "cities": "Array"
}
                                                
                                                    {
    "mensagem": "Nenhum estado encontrado"
}
                                                

BODY PARAMETERS

Field Type Description
estado String Nome do estado (Ex.: SP ou São Paulo)

region

Retorna todas as cidades em uma região
https://api.crmtony.com.br/v3/Integration/Geo/region

Coming Soon

Coming Soon

                                                    import requests

url = Integration/Geo/match
querystring =
                                                    # Clique aqui para visualizar o SDK
$.CRMTony('Integration/Geo/match', [], { "filtro": "Options", "comparar": "String" }, function(successData){
console.log(successData);
}, function(errorData){
console.log(errorData);
});
                                                    # Clique aqui para visualizar o SDK
$crmtony = new CRMTony();
$data = $crmtony->run('Integration/Geo/match', [], [
    "filtro" => "Options",
    "comparar" => "String",
]);

echo json_encode($data);
                                                    {
    "cities": "Array"
}
                                                
                                                    {
    "mensagem": "Nenhuma cidade encontrada"
}
                                                

BODY PARAMETERS

Field Type Description
filtro Options:
0 - RMVale
1 - LitoralNorte
2 - ValeSP
3 - ValeRJ
4 - Vale
Informe um filtro para a região
comparar String Informe um tempo para comparação de existencia

distance

Retorna a distancia entre duas cidades
https://api.crmtony.com.br/v3/Integration/Geo/distance

Coming Soon

Coming Soon

                                                    import requests

url = Integration/Geo/match
querystring = pontoA=String&pontoB=String&unidade=Options
                                                    # Clique aqui para visualizar o SDK
$.CRMTony('Integration/Geo/match', { "pontoA": "String", "pontoB": "String", "unidade": "Options" }, [], function(successData){
console.log(successData);
}, function(errorData){
console.log(errorData);
});
                                                    # Clique aqui para visualizar o SDK
$crmtony = new CRMTony();
$data = $crmtony->run('Integration/Geo/match', [
    "pontoA" => "String",
    "pontoB" => "String",
    "unidade" => "Options",
], []);

echo json_encode($data);
                                                    {
    "distance": 0
}
                                                
                                                    {
    "mensagem": "Nenhuma cidade encontrada"
}
                                                

GET PARAMETERS

Field Type Description
pontoA * String Informe a cidade de origem
pontoB * String Informe a cidade de destino
unidade Options:
mi - Milhas
m - Metros
km - Quilômetros
Informe a unidade de medida para retorno da distancia

Mercado Pago

sell

Gerar link de cobrança Mercado Pago
https://api.crmtony.com.br/v3/Integration/MPago/sell

Coming Soon

Coming Soon

                                                    import requests

url = Integration/MPago/match
querystring = cliente_token=Hash
                                                    # Clique aqui para visualizar o SDK
$.CRMTony('Integration/MPago/match', { "cliente_token": "Hash" }, { "titulo": "String", "valor": "Número (XXXX.XX ou X.XXX,XX)" }, function(successData){
console.log(successData);
}, function(errorData){
console.log(errorData);
});
                                                    # Clique aqui para visualizar o SDK
$crmtony = new CRMTony();
$data = $crmtony->run('Integration/MPago/match', [
    "cliente_token" => "Hash",
], [
    "titulo" => "String",
    "valor" => "Número (XXXX.XX ou X.XXX,XX)",
]);

echo json_encode($data);
                                                    {
    "mensagem": "Link de pagamento gerado com sucesso",
    "url": "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id={{pref_id}}"
}
                                                
                                                    {
    "mensagem": "Não foi encontrada nenhuma credencial para essa cobrança"
}
                                                
                                                    {
    "mensagem": "Não foi encontrado nenhum dado de cliente para cobrança"
}
                                                
                                                    {
    "mensagem": "Nenhum item encontrado para cobrança"
}
                                                

GET PARAMETERS

Field Type Description
cliente_token * Hash Token criado ao criar um novo cliente, utilizado para identificar o cliente

BODY PARAMETERS

Field Type Description
titulo * String Título da cobrança
valor * Número (XXXX.XX ou X.XXX,XX) Valor da cobrança