Exemplo Requests/Responses que esperamos de API

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

1 APP TOTEM Boleto Pegar infos de clientes (GET):
2 APP TOTEM Boleto Pegar boletos abertos/faturas (GET):
3 APP TOTEM Boleto Pegar Contratos do Cliente (GET):
4 APP Pegar notas fiscais (GET):
5 APP Pegar extratos financeiros (GET):
6 APP Pegar declaração de quitação de débitos (GET):
7 APP Pegar instalações/produtos de um cliente (GET):
8 PROSPECTO LEAD TOTEM Pegar todos os produtos (GET):
9 PROSPECTO LEAD TOTEM Pegar todos os revendedores (GET):
10 APP PROSPECTO TOTEM Pegar todos os funcionários (GET):
11 APP Pegar todos os departamentos (GET):
12 PROSPECTO TOTEM Pegar todos os vencimentos (GET):
13 PROSPECTO LEAD TOTEM Pegar as origens comerciais (GET):
14 PROSPECTO LEAD TOTEM Pegar todas as cidades (GET):
15 APP Pegar todos os tipos de atendimentos (GET):
16 PROSPECTO TOTEM Pegar todos os status de prospectos (GET):
17 PROSPECTO TOTEM Criar prospectos (POST):
18 LEAD TOTEM Criar lead (POST):
19 APP Criar atendimento (POST):
20 APP TOTEM Boleto Habilitação provisória (POST):
21 Prospecto TOTEM Edição do prospecto (PUT):
22 APP Edição do cliente (PUT):
23 Prospecto TOTEM Envio de arquivos (POST)
24 APP TOTEM Boleto Baixa na fatura/Sinalização de pagamento (POST)
25 Prospecto TOTEM Status do Prospecto (GET):

APP TOTEM Boleto Pegar infos de clientes (GET):

Request utilizada para pegar as informações do cliente no ERP com base no CPF/CNPJ dele

{
  "cnpj_cpf": ""  # Documento do cliente (cpf/cnpj)
}

{
    "nome_completo": "",            # Nome completo do cliente / razão social da empresa
    "aniversario": "",              # Data de aniversário do cliente
    "data_registro": "",            # Data de cadastro do cliente no ERP
    "ativo": "",                    # Cliente está ativo no ERP
    "id_remoto": "",                # ID do cliente dentro do ERP
    "id_contrato": "",              # ID do contrato do cliente
    "rua_endereco": "",             # Nome da rua do endereço do cliente
    "numero_endereco": "",          # Número da casa do endereço do cliente
    "cep_endereco": "",             # Cep do endereço do cliente
    "cidade_endereco": "",          # Cidade do endereço do cliente
    "complemento_endereco": "",     # Complemento do endereço do cliente
    "bairro_endereco": "",          # Bairro do endereço do cliente
    "estado_endereco": ""           # Estado do endereço do cliente
}

APP TOTEM Boleto Pegar boletos abertos/faturas (GET):

Request utilizada para listar os boletos dos clientes com base no documento do cliente (cpf/cnpj)

{
    "document": ""      # Documento do cliente (cpf/cnpj)
    "id_contrato": "",  # ID do contrato do cliente
}

APP TOTEM Boleto Pegar Contratos do Cliente (GET):

Request utilizado para listar o contratos do cliente. Utilizado para listar os boletos por contrato. Para pleno funcionamento, ID do contrato deverá ser enviado junto ao response que lista fatura abertas.

APP Pegar notas fiscais (GET):

Request utilizada para listar as notas fiscais emitidas para um cliente

APP Pegar extratos financeiros (GET):

Request utilizada para listar os extratos financeiros de um cliente

APP Pegar declaração de quitação de débitos (GET):

Request utilizada para listar as declarações de quitação de débito de um cliente

APP Pegar instalações/produtos de um cliente (GET):

Request para listar todos os produtos/instalações/serviços de um cliente

PROSPECTO LEAD TOTEM 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

PROSPECTO LEAD TOTEM 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

APP PROSPECTO TOTEM 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

APP 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

PROSPECTO TOTEM Pegar todos os vencimentos (GET):

Request utilizada para listar os vencimentos, isso é utilizado para que os prospectos sejam criados com o vencimento vinculado corretamente

PROSPECTO LEAD TOTEM Pegar as origens comerciais (GET):

Request utilizada para listar as origens comerciais, 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)

PROSPECTO LEAD TOTEM 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.

APP 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 caiam no sistema com o tipo correto

PROSPECTO TOTEM 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)

PROSPECTO TOTEM Criar prospectos (POST):

Request utilizada para a criação de uma prospecção no sistema, esse é o principal canal de entrada de novas assinaturas.

Se for necessário o EPR deve informar todos APIs necessárias para criar um pedido no sistema integrado com o maior numero das informações possível.

Se for o caso pode-se fracionar o em varias APIs para chegar ao resultado final, exemplo: API para cadastro de Prospecto/Cliente, API para cadastro de endereço, APi para upload de arquivos no prospecto, etc.

LEAD TOTEM 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.

Dados podem varia conforme formulário do pre-checkout

APP Criar atendimento (POST):

Request utilizada para criar um atendimento/chamado/ajuda com a possibilidade de enviar um anexo em formato Base64

APP TOTEM Boleto 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

Prospecto TOTEM 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

APP 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)

Prospecto TOTEM 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

APP TOTEM Boleto 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

Prospecto TOTEM Status do Prospecto (GET):

Request utilizada para receber o status atual do prospecto, mantendo o sistema da Datacake sincronizado com o ERP