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
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
Payload
{
"cnpj_cpf": "" # Documento do cliente (cpf/cnpj)
}
Response
{
"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
"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)
Payload
{
"document": "" # Documento do cliente (cpf/cnpj)
}
Response
{
[
{
"id_fatura": "", # ID utilizado para identificação e baixa de Fatura
"code_fatura": "", # Valor composto pelo ID da fatura e docuemento do cliente
"nome_cliente": "", # Nome do Cliente
"document_number": "", # Documento do cliente, o mesmo informado para obter as faturas
"remote_id": "", # Código do cliente no ERP
"valor_inicial": "", # Valor original do Boleto
"valor_atual": "", # Valor atualizado na data da Consulta
"juros": "", # Juros aplicado ao boleto na data de consulta
"multa": "", # Multa aplicado ao boleto na data de consulta
"desconto": "", # Desconto aplicado ao boleto na data de consulta
"data_emissao": "", # Data de emissão do Boleto
"data_vencimento": "", # Data de vencimento do Boleto
"historico": "", # Mensagem de referência da Fatura (ex. Mensalidade Plano X)
"bank_code": "", # Codigo que indica a qual banco pertence a fatura
"linha_digitavel": "", # Linha digitavel do Boleto
"integration_id": "", # Id da integraçõ ERP a qual o boleto pertence
"identifier": "", # Identificador de pagamento (Ex. Carteira de cobrança)
"pix_code": "", # Código PIX copia e cola de sistema de pagamento do ERP
"contract_id": "" # Id do contrado(s) a qual pertence a Fatura
"bill_receipt": "", # Cabeço de impressão gerado para o Totem (TEF)
"bill_pix_receipt": "", # Cabeço de impressão gerado para o Totem (PIX)
}
]
}
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.
Payload
{
"document": "" # Documento do cliente (cpf/cnpj)
}
Response
{
"remote_id": "", # Id do Contrato no ERP. Utilizado para filtrar o boletos
"contract_name": "" # Endereço da instalação
}
APP Pegar notas fiscais (GET):
Request utilizada para listar as notas fiscais emitidas para um cliente
Payload
{
"document": "" # Documento do cliente (cpf/cnpj)
"id_cliente": "" # ID do cliente no ERP
}
Response
{
[
{
"id_nota": "", # ID da nota fiscal dentro do ERP
"id_tipo_nota: "", # ID do tipo da nota fiscal dentro do ERP
"numero_nota": "", # Número da nota fiscal
"valor": "", # Valor da nota fiscal
"protocolo": "", # Protocolo da nota fiscal
"data_lancamento": "", # Data que a nota foi lançada no ERP
"identificacao": "", # Identificação da nota fiscal
"url_nota_fiscal": "", # Url do pdf da nota fiscal
}
]
}
Request utilizada para listar os extratos financeiros de um cliente
Payload
{
"document": "" # Documento do cliente (cpf/cnpj)
"id_cliente": "" # ID do cliente no ERP
}
Response
{
[
{
"id_nota": "", # ID da fatura
"data_lancamento": "", # Data de lançamento da fatura
"data_vencimento": "", # Data de vencimento da fatura
"data_baixa": "", # Data da baixa da fatura
"historico": "", # Histórico da fatura
"valor": "", # Valor recebido da fatura
"saldo": "", # Valor da fatura
"cobranca": "", # Descrição da cobrança
}
]
}
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
Payload
{
"document": "" # Documento do cliente (cpf/cnpj)
"id_cliente": ""
}
Response
{
[
{
"id_quitacao": "", # ID da quitação de débito
"ano": "", # Ano referente a quitação de débito
"valor": "", # Valor total da quitação de débito
"url_arquivo": "" # URL do pdf da quitação de débito
}
]
}
APP 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": ""
}
]
}
]
}
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
Response
{
[
{
"id_servico": "",
"nome": "",
"descricao": "",
"valor": "",
"obs": ""
}
]
}
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
Response
{
[
{
"id_revendedor": "",
"nome": "",
"obs": ""
}
]
}
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
Response
{
[
{
"id_funcionario": "",
"nome": "",
"obs": ""
}
]
}
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
Response
{
[
{
"id_departamento": "",
"nome": "",
"obs": ""
}
]
}
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
Response
{
[
{
"id_vencimento": "",
"data": "",
"obs": ""
}
]
}
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)
Response
{
[
{
"id_origem": "",
"nome": "",
"obs": ""
}
]
}
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.
Response
{
[
{
"id_cidade": "",
"nome": "",
"latitude": "",
"longitude": "",
"obs": ""
}
]
}
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 sejam do tipo correto utilizado
Response
{
[
{
"id_tipo_de_atendimento": "",
"nome": "",
"obs": ""
}
]
}
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)
Response
{
[
{
"status_prospeccao": "",
"nome": "",
"obs": ""
}
]
}
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.
Payload
{
"nome": "", # Nome do Cliente ou Responsavel pela Empresa
"razão_social": "", # Razão do social para clientes PJ (Opcioanl)
"tipo_pessoa": "", # Pessoa Física ou Juridica
"cnpj_cpf": "", # CPF ou CNPJ
"ie_identidade": "", # Inscrição Estadual
"data_nascimento": "", # Data de nascimento do cliente ou do responsável
"id_revendedor": "", # Id revendedor
"id_origem": "", # Id Origem comercial
"id_vencimento": "", # Id do Vencimento no ERP
"cep": "", # CEP do cliente
"endereco": "", # Logradouro
"numero": "", # Numero
"bairro": "", # Bairro
"cidade": "", # Cidade
"complemento": "", # Complemento
"referencia": "", # Referencia
"uf": "", # Estado
"latitude": "", # Latitude
"longitude": "", # Longitude
"telefone": "", # Telefone Principal
"celular": "", # Telefone Secundario
"celular_extra": "", # Whats APP
"email": "", # Email
"obs": "", # Resumo de todas as informa
"servicos": [ # Array serviços contratados/interesse
{
"id_serviços"
}
],
"anexos": [ # Array de anexos dos documentos anexados ao pedido
{
"nome_documento": "",
"formato": "",
"base_64" ""
}
]
}
Response
{
"id_prospecto": "", # Id do Prospecto retornado do ERP
"obs": "" # Observação o menssagem do ERP
}
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
Payload
{
"nome": "", # Nome
"taxvat": "", # Documento
"email": "", # Email
"phone": "", # Telefone
"address": "", # Logradouro
"number": "", # Numero
"neighborhood": "", # Bairro
"city": "", # Cidade
"state": "", # Estado
"postal_code": "", # CEP
"coverage": "", # JSON com dados da Cobertura
"latitude": "", # Latitude
"longitude": "", # Longitude
"reseller": "", # Revendedor
"extra_data": "" # Dados
}
Response
{
"id_lead": "",
"obs": ""
}
APP 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": ""
}
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
Payload
{
"id_cliente": "id_cliente",
"id_servico": "id_servico",
}
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
Payload
{
"id_prospecto": "",
"status_prospeccao": "status_prospeccao",
"id_revendedor": "id_revendedor",
"obs": "",
"alerta": "",
}
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)
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": ""
}
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
Payload
{
"id_prospecto": "",
"nome_arquivo": "",
"arquivo": ""
"obs": "",
}
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
Payload
{
"id_cliente": "id_cliente",
"id_fatura": "id_fatura",
}
PROSPECTO TOTEM 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"
}
Adicionar Comentário