Este documento mostra todas as requisições e respostas esperadas em uma integração padrão de ERP e site de assinatura Datacake.
Exemplo de requisições GET, POST e PUT com payload e resposta esperadas em JSON para integração. Recomendamos autenticação com token no header da requisição
Pegar infos de clientes (GET):
Request utilizada para pegar as informações do cliente no ERP com base no CPF/CNPJ dele
Response
{
"id_cliente": "",
"nome": "",
"fantasia": "",
"tipo_pessoa": "",
"cnpj_cpf": "",
"ie_identidade": "",
"rg_orgao_emissor": "",
"inscricao_municipal": "",
"contribuinte_icms": "N",
"nacionalidade": "",
"cidade_naturalidade": "",
"estado_nascimento": "",
"data_nascimento": "",
"estado_civil": "",
"ativo": "",
"Sexo": "",
"profissao": "",
"data_cadastro": "",
"cep": "",
"endereco": "",
"numero": "",
"complemento": "",
"bairro": "",
"cidade": "",
"uf": "",
"latitude": "",
"longitude": "",
"fone": "",
"telefone_comercial": "",
"telefone_celular": "",
"whatsapp": "",
"email": "",
"obs": "",
"alerta": ""
}
Pegar boletos abertos/faturas (GET):
Request utilizada para listar os boletos dos clientes com base id do cliente
Response
{
[
{
"id_fatura": "",
"nome_cliente": "",
"valor_inicial": "",
"valor_atual": "",
"data_emissao": "",
"data_vencimento": "",
"linha_digitavel": "",
"url_boleto": ""
}
]
}
Pegar notas fiscais (GET):
Request utilizada para listar as notas fiscais emitidas para um cliente
Response
{
[
{
"id_nota": "",
"status": "",
"valor": "",
"valor_pago": "",
"data_lancamento": "",
"data_vencimento": "",
"data_baixa": "",
"url_nota_fiscal": "",
}
]
}
Request utilizada para listar os extratos financeiros de um cliente
Response
{
[
{
"id_extrato_financeiro": "",
"data_lancamento": "",
"data_vencimento": "",
"data_baixa": "",
"id_boleto": "",
"id_nota": "",
"valor": "",
"valor_pago": "",
"multa": "",
"juros": "",
"desconto": "",
"obs": ""
}
]
}
Pegar declaraçao de quitação de débitos (GET):
Request utilizada para listar as declarações de quitação de débito de um cliente
Response
{
[
{
"id_quitacao": "",
"ano": "",
"valor": "",
"url_arquivo": ""
}
]
}
Pegar instalações/produtos de um cliente (GET):
Request para listar todos os produtos/instalações/serviços de um cliente
Response
{
[
{
"id_instalacao": "",
"cep": "",
"endereco": "",
"numero": "",
"complemento": "",
"bairro": "",
"cidade": "",
"uf": "",
"latitude": "",
"longitude": "",
"obs": "",
"servicos": [
{
"id_servico": "",
"nome": "",
"descricao": "",
"valor": "",
"status": "",
"obs": ""
}
]
}
]
}
Pegar todos os produtos (GET):
Request utilizada para listar todos os produtos disponíveis no sistema. Isso é utilizado para mapear o produto do eCommerce, assim o prospecto/lead já é criado com um vínculo aos produtos
Response
{
[
{
"id_servico": "",
"nome": "",
"descricao": "",
"valor": "",
"obs": ""
}
]
}
Pegar todos os revendedores (GET):
Request utilizada para listar todos os revendedores, Isso é utilizado para mapear os revendedores no eCommerce, assim as vendas dos mesmos podem ser vinculados a eles nos relatórios e os prospectos/leads já são criados com o vínculo do revendedor que realizou a venda/captação
Response
{
[
{
"id_revendedor": "",
"nome": "",
"obs": ""
}
]
}
Pegar todos os funcionários (GET):
Request utilizada para listar todos os funcionários, Isso é utilizado para direcionar os atendimentos gerados pelo eCommerce/App caso eles sejam vinculados com um funcionário
Response
{
[
{
"id_funcionario": "",
"nome": "",
"obs": ""
}
]
}
Pegar todos os departamentos (GET):
Request utilizada para listar todos os departamentos, Isso é utilizado para direcionar os atendimentos gerados pelo eCommerce/App caso eles sejam vinculados com um departamento
Response
{
[
{
"id_departamento": "",
"nome": "",
"obs": ""
}
]
}
Pegar todos os vencimentos (GET):
Request utilizada para listar os vencimentos, isso é utilizado para que os prospectos sejam criados com o vencimento vinculado corretamente
Response
{
[
{
"id_vencimento": "",
"data": "",
"obs": ""
}
]
}
Pegar as origens comerciáis (GET):
Request utilizada para listar as origens comerciáis, isso é utilizado para que os prospectos sejam criados com a origem comercial vinculada corretamente. (Ex. Google, Outdoor, Indicação de Amigo, Anúncio de Rádio)
Response
{
[
{
"id_origem": "",
"nome": "",
"obs": ""
}
]
}
Pegar todas as cidades (GET):
Request utilizada para listar as cidades cadastradas no sistema, isso é utilizado pois muitos sistemas utilizam um código proprietário para a cidade. assim os prospectos são criados com a cidade vinculada corretamente.
Response
{
[
{
"id_cidade": "",
"nome": "",
"latitude": "",
"longitude": "",
"obs": ""
}
]
}
Pegar todos os tipos de atendimentos (GET):
Request utilizada para listar todos os tipos de atendimentos, Isso é utilizado para que os atendimentos criados pelo eCommerce/App sejam do tipo correto utilizado
Response
{
[
{
"id_tipo_de_atendimento": "",
"nome": "",
"obs": ""
}
]
}
Pegar todos os status de prospectos (GET):
Request utilizada para listar os status de prospectos, isso é utilizado para classificar os prospectos conformes eles são criados e para atualizar os prospectos durante a automação. (Ex. Inicial, Em analise, Reprovado, Suspenso, Aprovado, Cancelado)
Response
{
[
{
"status_prospeccao": "",
"nome": "",
"obs": ""
}
]
}
Criar prospectos (POST):
Request utilizada para a criação de uma prospecção no sistema, esse é o principal canal de entrada de novas assinaturas
Payload
{
"nome": "",
"nome_fantasia": "",
"status_prospeccao": "status_prospeccao",
"tipo_pessoa": "",
"cnpj_cpf": "",
"ie_identidade": "",
"data_nascimento": "",
"data_cadastro": "",
"id_revendedor": "id_revendedor",
"id_origem": "id_origem",
"id_vencimento": "id_vencimento",
"cep": "",
"endereco": "",
"numero": "",
"bairro": "",
"cidade": "",
"id_cidade": "id_cidade",
"complemento": "",
"referencia": "",
"uf": "",
"latitude": "",
"longitude": "",
"fone": "",
"telefone_comercial": "",
"telefone_celular": "",
"whatsapp": "",
"ramal": "",
"email": "",
"obs": "",
"alerta": "",
"servicos": [
{
"id_servico": ""
}
]
}
Response
{
"id_prospecto": "",
"obs": ""
}
Criar lead (POST):
Request utilizada para a criação de um lead no sistema, esse é como você irá registrar clientes que tem a intenção de assinar no futuro ou que ainda não estão cobertos pelos seus serviços/produtos
Payload
{
"nome": "",
"nome_fantasia": "",
"tipo_pessoa": "",
"cnpj_cpf": "",
"ie_identidade": "",
"data_nascimento": "",
"data_cadastro": "",
"id_revendedor": "id_revendedor",
"cep": "",
"endereco": "",
"numero": "",
"bairro": "",
"cidade": "",
"id_cidade": "id_cidade",
"complemento": "",
"referencia": "",
"uf": "",
"latitude": "",
"longitude": "",
"fone": "",
"telefone_comercial": "",
"telefone_celular": "",
"whatsapp": "",
"ramal": "",
"email": "",
"obs": "",
"alerta": "",
"servicos": [
{
"id_servico": ""
}
]
}
Response
{
"id_lead": "",
"obs": ""
}
Criar atendimento (POST):
Request utilizada para criar um atendimento/chamado/ajuda com a possibilidade de enviar um anexo em formato Base64
Payload
{
"id_cliente": "id_cliente",
"id_servico": "id_servico",
"id_tipo_de_atendimento": "id_tipo_de_atendimento",
"id_departamento": "id_departamento",
"id_funcionario": "id_funcionario",
"email": "",
"telefone": "",
"assunto": "",
"mensagem": "",
"obs": "",
"alerta": "",
"anexo": [
{
"anexo": B64_DO_ARQUIVO,
"obs": "",
"nome_anexo": ""
}
]
}
Response
{
"id_atendiemnto": "",
"obs": ""
}
Habilitação provisória (POST):
Request utilizada para habilitar provisoriamente um serviço suspenso geralmente por falta de pagamento. também conhecido como ativação de confiança
Payload
{
"id_cliente": "id_cliente",
"id_servico": "id_servico",
}
Edição do prospecto (PUT):
Request utilizada para atualizar uma prospecção conforme a automação acontece. Nem todos os campos são necessariamente editados/atualizados
Payload
{
"id_prospecto": "",
"status_prospeccao": "status_prospeccao",
"id_revendedor": "id_revendedor",
"obs": "",
"alerta": "",
}
Edição do cliente (PUT):
Request utilizada para atualizar as informações de um cliente. Geralmente atualiza-se apenas as informações de contato (email, telefone, WhatsApp)
Payload
{
"id_cliente": "",
"nome": "",
"fantasia": "",
"tipo_pessoa": "",
"cnpj_cpf": "",
"ie_identidade": "",
"rg_orgao_emissor": "",
"inscricao_municipal": "",
"contribuinte_icms": "N",
"nacionalidade": "",
"cidade_naturalidade": "",
"estado_nascimento": "",
"data_nascimento": "",
"estado_civil": "",
"ativo": "",
"Sexo": "",
"profissao": "",
"data_cadastro": "",
"cep": "",
"endereco": "",
"numero": "",
"complemento": "",
"bairro": "",
"cidade": "",
"uf": "",
"latitude": "",
"longitude": "",
"fone": "",
"telefone_comercial": "",
"telefone_celular": "",
"whatsapp": "",
"email": "",
"obs": "",
"alerta": ""
}
Envio de arquivos (POST)
Request utilizada para enviar arquivos anexados pelos clientes na hora da assinatura, de modo a deixar os arquivos vinculados aos prospectos/leads. Os arquivos são enviados em Base64, geralmente imagens (jpg, png, gif) ou PDF
Payload
{
"id_prospecto": "",
"nome_arquivo": "",
"arquivo": ""
"obs": "",
}
Baixa na fatura/Sinalização de pagamento (POST)
Request utilizada para sinalizar ao ERP que a fatura em questão do cliente foi paga pelo terminal de atendimento da Datacake (Totem) ou pelo aplicativo; permitindo o ERP marcar a mesma como paga e caso necessário retomar os serviços suspensos
Payload
{
"id_cliente": "id_cliente",
"id_fatura": "id_fatura",
}
Status do Prospecto (GET):
Request utilizada para receber o status atual do prospecto, mantendo o sistema da Datacake sincronizado com o ERP
Payload
{
"id_prospecto": "id_prospecto",
}
Response
{
"status": "",
"motivo": "motivo_do_cancelamento_ou_rejeição"
}
0 Comentários