Comparação de Páginas

...

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

Índice

minLevel	1
maxLevel	7
outline	true

Estado
title APP
Estado
colour Yellow
title TOTEM
Estado
colour Green
title Boleto
Pegar infos de clientes (GET):

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

Expandir

title	Payload

Bloco de código

language	json

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

Expandir

title	Response

Bloco de código

language	json

{
    "idnome_clientecompleto": "",            # Nome "nome": "",
    "fantasia": "",completo do cliente / razão social da empresa
    "tipo_pessoaaniversario": "",     "cnpj_cpf": "",       "ie_identidade": "", # Data de  "rg_orgao_emissor": "",aniversário do cliente
    "inscricaodata_municipalregistro": "",     "contribuinte_icms": "N",       "nacionalidade": "",
    "cidade_naturalidade": "",# Data de cadastro do cliente no ERP
    "estado_nascimentoativo": "",     "data_nascimento": "",     "estado_civil": "",
    "ativo": "",         # Cliente está ativo no ERP
    "Sexoid_remoto": "",              "profissao": "",
    "data_cadastro": "",  # ID do cliente dentro do ERP
    "cepid_contrato": "",      "endereco": "",     "numero": "", # ID do contrato "complemento": "",do cliente
    "bairrorua_endereco": "",     "cidade": "",        "uf": "",
    "latitude": "",# Nome da rua do endereço do cliente
    "longitudenumero_endereco": "",     "fone": "",     "telefone_comercial": "",
    "telefone_celular": "",# Número da casa do endereço do cliente
    "whatsappcep_endereco": "",      "email": "",     "obs": "",
    "alerta": ""
}

Pegar boletos abertos/faturas (GET):

Request utilizada para listar os boletos dos clientes com base id do cliente

Expandir

title	Payload

Bloco de código

language	json

{ # Cep do endereço do cliente
    "idcidade_clienteendereco": ""
}

Expandir

title	Response

Bloco de código

language	json

{,      [    # Cidade do endereço  {
    do cliente
     "idcomplemento_faturaendereco": "",     # Complemento do endereço do cliente
    "nomebairro_clienteendereco": "",          # Bairro  "valor_inicial": "",  
    do endereço do cliente
     "valorestado_atualendereco": "",           #  "data_emissao": "",  
          "data_vencimento": "",Estado do endereço do cliente
}

Estado
title APP
Estado
colour Yellow
title TOTEM
Estado
colour Green
title Boleto
Pegar boletos abertos/faturas (GET):

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

Expandir

title	Payload

Bloco de código

language	json

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

Expandir

title	Response

Bloco de código

language	json

{
    [
 "url_boleto": ""      {
  }     ] }

Pegar notas fiscais (GET):

Request utilizada para listar as notas fiscais emitidas para um cliente

Expandir

title	Payload

Bloco de código

language	json

{     "id_clientefatura": ""
}

Expandir

title	Response

Bloco de código

language	json

{,      [  # ID utilizado para identificação e baixa {de Fatura 
          "idcode_notafatura": "",      # Valor composto pelo ID da fatura e docuemento "status": "",do cliente  
            "valornome_cliente": "",     # Nome do Cliente
          "valordocument_pagonumber": "",  # Documento do cliente, o mesmo informado para obter as faturas
  "data_lancamento        "remote_id": "",        # Código do cliente no ERP
          "datavalor_vencimentoinicial": "",    # Valor original do Boleto
          "datavalor_baixaatual": "",      # Valor atualizado na data da Consulta
        "url_nota_fiscal  "juros": "",           } # Juros aplicado ao ]
}

Pegar extratos financeiros (GET):

Request utilizada para listar os extratos financeiros de um cliente

Expandir

title	Payload

Bloco de código

language	json

{boleto na data de consulta
          "id_clientemulta": ""
}

Expandir

title	Response

Bloco de código

language	json

{,      [      # Multa  {
 aplicado ao boleto na data de consulta
          "id_extrato_financeirodesconto": "",         # Desconto aplicado ao boleto na "data_lancamento": "",
  de consulta
          "data_vencimentoemissao": "",     # Data de emissão do Boleto
          "data_baixavencimento": "",  # Data de vencimento do Boleto
          "id_boletohistorico": "",        # Mensagem de referência  "id_nota": "",
 da Fatura (ex. Mensalidade Plano X)
          "valorbank_code": "",        # Codigo que indica  "valor_pago": "",
 a qual banco pertence a fatura
          "multalinha_digitavel": "",  # Linha digitavel do Boleto
          "jurosintegration_id": "",   # Id da integraçõ ERP a qual o boleto pertence
          "descontoidentifier": "",       # Identificador de pagamento (Ex. Carteira de cobrança)
          "obspix_code": "",         }# Código PIX copia e ]cola }

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

Expandir

title	Payload

Bloco de código

language	json

{de sistema de pagamento do ERP
          "contract_id_cliente": "" }

Expandir

title	Response

Bloco de código

language	json

{     [ # Id do contrado(s) a qual pertence a {
Fatura
           "idbill_quitacaoreceipt": "",     # Cabeço de impressão gerado para o Totem (TEF)
      "ano    "bill_pix_receipt": "", # Cabeço de impressão gerado para o        "valor": "",Totem (PIX)
              "url_arquivo": ""
        }
    ]
}

Estado
title APP
Estado
colour Yellow
title TOTEM
Estado
colour Green
title

...

Boleto
Pegar Contratos do Cliente (GET):

Request utilizado para listar todos os produtos/instalações/serviços de um clienteo 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.

Expandir

title	Payload

Bloco de código

language	json

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

Expandir

title	Response

Bloco de código

language	json

{
    [
"remote_id": "",      # Id {do Contrato no ERP. Utilizado para filtrar o boletos
    "idcontract_instalacaoname": "",   # Endereço da          "cepinstalação
}

Estado
title APP
Pegar notas fiscais (GET):

Request utilizada para listar as notas fiscais emitidas para um cliente

Expandir

title	Payload

Bloco de código

language	json

{
    "document": "",    # Documento do cliente (cpf/cnpj)
    "enderecoid_cliente": "",  # ID do cliente no ERP
}

Expandir

title	Response

Bloco de código

language	json

{
    "numero": "",[
        {
    "complemento": "",        "id_nota": "",      "bairro": "",       # ID da nota fiscal dentro "cidade": "",do ERP
            "uf"id_tipo_nota: "",          # ID do tipo da nota fiscal dentro "latitude": "",do ERP
            "longitudenumero_nota": "",          # Número da "obs": "",nota fiscal
            "servicosvalor": ["",                # {Valor da nota fiscal
                 "id_servico": "protocolo": "",            # Protocolo da nota fiscal
    "nome": "",       "data_lancamento": "",      # Data que a nota foi lançada "descricao": "",
     no ERP  
            "valoridentificacao": "",        # Identificação da nota fiscal
            "statusurl_nota_fiscal": "",      # Url do pdf da nota fiscal 
       "obs": "" }
         ]
}

Estado
title APP
Pegar extratos financeiros (GET):

Request utilizada para listar os extratos financeiros de um cliente

Expandir

title	Payload

Bloco de código

language	json

{
    "document": ""    # Documento }do cliente (cpf/cnpj)
    "id_cliente": ""  # ID do ]cliente no ERP
}

Expandir

title	Response

Bloco de código

language	json

{
    [
}     ] }

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

Expandir

title	Payload

Bloco de código

language	json

{}

Expandir

title	Response

Bloco de código

language	json

{     [
        {
            "id_serviconota": "",             "nome": "",    # ID da fatura
            "descricaodata_lancamento": "",          # Data de lançamento da fatura
   "valor         "data_vencimento": "",          # Data de vencimento da fatura
            "obsdata_baixa": "",               }
 # Data da baixa da fatura
  ] }

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

Expandir

title	Payload

Bloco de código

language	json

{}

Expandir

title	Response

Bloco de código

language	json

{     [    "historico": "",    {             "id_revendedor": "",# Histórico da fatura
            "nomevalor": "",             "obs": ""      # Valor recebido }da fatura
   ] }

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

Expandir

title	Payload

Bloco de código

language	json

{}

Expandir

title	Response

Bloco de código

language	json

{     [   "saldo": "",     {               #  "id_funcionario": "",Valor da fatura
            "nomecobranca": "",               "obs": ""  # Descrição da cobrança
        }
    ]
}

...

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

Request utilizada para listar todos os departamentos, Isso é utilizado para direcionar os atendimentos gerados pelo eCommerce/App caso eles sejam vinculados com um departamentoas declarações de quitação de débito de um cliente

Response

Expandir

title	Payload

Bloco de código

language	json

{}

Expandir

title


    "document": ""    # Documento do cliente (cpf/cnpj)
    "id_cliente": ""  # ID do cliente no ERP
}

Expandir

title	Response

Bloco de código

language	json

{
    [
        {
            "id_departamentoquitacao": "",    # ID da quitação de débito
            "nomeano": "",            # Ano referente "obs": ""
 a quitação de débito
      }     ]
}

Pegar todos os vencimentos (GET):

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

Expandir

title	Payload

Bloco de código

language	json

{}

Expandir

title	Response

Bloco de código

language	json

{ "valor": "",       [   # Valor total da quitação de {débito
            "idurl_vencimentoarquivo": "",     # URL do pdf da quitação de débito
 "data": "",
            "obs": ""         }
    ]
}

Estado
title APP
Pegar

...

instalações/produtos de um cliente (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)todos os produtos/instalações/serviços de um cliente

Expandir

title	Payload

Bloco de código

language	json

{}

Expandir

title


    "document": ""    # Documento do cliente (cpf/cnpj)
    "id_cliente": ""  # ID do cliente no ERP
}

Expandir

title	Response

Bloco de código

language	json

{
    [
        {
            "id_origemservico": "",           # ID do serviço no ERP
            "nome": "",             "obs": ""    # Nome do serviço
   }     ] }

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.

Expandir

title	Payload

Bloco de código

language	json

{}

Expandir

title	Response

Bloco de código

language	json

{   "situacao": "", [         {   # Situação do serviço no ERP (ativo, suspenso, etc.)
            "id_cidadeobs": "",                  # Observações/comentários sobre o serviço
            "nomevalor": "",                # Valor "latitude": "",do serviço
            "longitudenumero_plano": "",         # Número/posição do serviço no "obs": ""ERP
         }   "endereco": "", ] }

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

Expandir

title	Payload

Bloco de código

language	json

{}

Expandir

title	Response

Bloco de código

language	json

{     [      # Endereço referente {ao serviço do cliente
         "id_tipo_de_atendimento": "",}
              "nome": "",
            "obs": ""
        }
    ]
}

...

]
}

Estado
colour Purple
title PROSPECTO
Estado
colour Red
title LEAD
Estado
colour Yellow
title TOTEM
Pegar todos os produtos (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)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

Expandir

title	Payload

Bloco de código

language	json

{}

Expandir

title	Response

Bloco de código

language	json

{
    [
        {
            "statusid_prospeccaoservico": "",   # ID do produto/serviço no ERP
            "nome": "",         # Nome de apresentação "obs": ""do produto
        }     ]
}

Criar prospectos (POST):

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

Expandir

title	Payload

Bloco de código

language	json

{
    "nome": "","descricao": "",    # Descrição do produto
      "nome_fantasia": "",     "status_prospeccaovalor": "status_prospeccao",       "tipo_pessoa": "",
    "cnpj_cpf": "", # Valor do produto
      "ie_identidade": "",     "data_nascimentoobs": "",     "data_cadastro": "",     "id_revendedor": "id_revendedor",
    "id_origem": "id_origem",# Observações
       "id_vencimento": "id_vencimento", }
    "cep": "",
    "endereco": "",
    "numero": "",
    "bairro": "",
    "cidade": "",
    "id_cidade": "id_cidade",
    "complemento": "",
    "referencia": "",]
}

Estado
colour Purple
title PROSPECTO
Estado
colour Red
title LEAD
Estado
colour Yellow
title 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

Expandir

title	Payload

Bloco de código

language	json

{}

Expandir

title	Response

Bloco de código

language	json

{
    [
        {
            "ufid_revendedor": "",  # ID do "latitude": "",revendedor no ERP
            "longitudenome": "",         "fone": "", # Nome do revendedor
"telefone_comercial": "",     "telefone_celular": "",     "whatsappdocumento": "",     "ramal": "",
    "email": "", # Documento do revendedor (CPF/CNPJ)
      "obs": "",     "alertaemail": "",     "servicos": [    # Email do revendedor
 {             "id_servicoobs": ""         }    # Observações
] }

Expandir

title	Response

Bloco de código

language	json

{     "id_prospecto": "", }
   "obs": ""
}

...

]
}

Estado
title APP
Estado
colour Purple
title PROSPECTO
Estado
colour Yellow
title TOTEM
Pegar todos os funcionários (GET):

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/produtoslistar todos os funcionários, Isso é utilizado para direcionar os atendimentos gerados pelo eCommerce/App caso eles sejam vinculados com um funcionário

Expandir

title	Payload

Bloco de código

language	json

{}

Expandir

title	Response

Bloco de código

language	json

{
    "nome": "",[
     "nome_fantasia": "",  {
  "tipo_pessoa": "",     "cnpj_cpf": "",
    "ieid_identidadefuncionario": "",   #  "data_nascimento": "",ID do funcionário no ERP
      "data_cadastro": "",     "id_revendedornome": "id_revendedor",     "cep": "",     "endereco": "", # Nome do funcionário
"numero": "",     "bairro": "",     "cidadeobs": "",     "id_cidade": "id_cidade",     "complemento": "",   # Observações
"referencia": "",     "uf": "",  }
     "latitude": "",]
}

Estado
title 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

Expandir

title	Payload

Bloco de código

language	json

{}

Expandir

title	Response

Bloco de código

language	json

{
    [
"longitude": "",        {
"fone": "",     "telefone_comercial": "",     "telefoneid_celulardepartamento": "",    # "whatsapp": "",
    "ramal": "",ID do departamento no ERP
      "email": "",     "obsnome": "",     "alerta": "",     "servicos": [   # Nome do    {departamento
            "id_servicoobs": ""         }        # ]
}

Expandir

title	Response

Bloco de código

language	json

{Observações
      "id_lead": "", }
   "obs": ""
}

...

]
}

Estado
colour Purple
title PROSPECTO
Estado
colour Yellow
title TOTEM
Pegar todos os vencimentos (GET):

Request utilizada para criar um atendimento/chamado/ajuda com a possibilidade de enviar um anexo em formato Base64para listar os vencimentos, isso é utilizado para que os prospectos sejam criados com o vencimento vinculado corretamente

Expandir

title	Payload

Bloco de código

language	json

{
 }

Expandir

title	Response

Bloco de código

language	json

{
  "id_cliente": "id_cliente", [
   "id_servico": "id_servico",     "id_tipo_de_atendimento": "id_tipo_de_atendimento",{
      "id_departamento": "id_departamento",     "id_funcionariovencimento": "id_funcionario",    # ID "email": "",
 do vencimento no ERP
  "telefone": "",
    "assunto": "",     "mensagemdata": "",     "obs": "",     "alerta": "",
    # "anexoNome": [da data de vencimento (Exemplo:     {
            "anexo": B64_DO_ARQUIVO,"dia 5")
             "obs": "",               "nome_anexo": ""# Observações
        }
    ]
}

Estado

...

colour Purple
title

...

Bloco de código

language	json

{
    "id_atendiemnto": "",
    "obs": ""
}

...

PROSPECTO
Estado
colour Red
title LEAD
Estado
colour Yellow
title TOTEM
Pegar as origens comerciais (GET):

Request utilizada para habilitar provisoriamente um serviço suspenso geralmente por falta de pagamento. também conhecido como ativação de confiançapara 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)

Expandir

title	Payload

Bloco de código

language	json

{
    "id_cliente": "id_cliente",
    "id_servico": "id_servico",
}

Expandir

title	Response

Bloco de código

language	json

{
    [
        {
        "status    "id_origem": "",
}

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

Expandir

title	Payload

Bloco de código

language	json

{    # ID da origem comercial no ERP
            "id_prospectonome": "",         # Nome da origem comercial
"status_prospeccao": "status_prospeccao",     "id_revendedor": "id_revendedor",     "obs": "",     "alerta": "",
}

Expandir

title	Response

Bloco de código

language	json

{
    "status": "",
}

...

      # Observações
        }
    ]
}

Estado
colour Purple
title PROSPECTO
Estado
colour Red
title LEAD
Estado
colour Yellow
title TOTEM
Pegar todas as cidades (GET):

Request utilizada para atualizar as informações de um cliente. Geralmente atualiza-se apenas as informações de contato (email, telefone, WhatsApp)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.

Expandir

title	Payload

Bloco de código

language	json

{}

Expandir

title	Response

Bloco de código

language	json

{
    [
   "id_cliente": "",    {
"nome": "",     "fantasia": "",     "tipoid_pessoacidade": "",     "cnpj_cpf": "",# ID da cidade no ERP
            "ie_identidadenome": "",     "rg_orgao_emissor": "",
    "inscricao_municipal": "",    # Nome da cidade no ERP
      "contribuinte_icms": "N",     "nacionalidadelatitude": "",     # Latitude "cidade_naturalidade": "",da cidade
      "estado_nascimento": "",     "data_nascimentolongitude": "",     "estado_civil": "",
# Longitude da cidade
   "ativo": "",     "Sexo": "",
    "profissaoobs": "",     "data_cadastro": "",     "cep": "",# Observações
    "endereco": "",   }
 "numero": "",     "complemento": "",
    "bairro": "",
    "cidade": "",]
}

Estado
title 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

Expandir

title	Payload

Bloco de código

language	json

{}

Expandir

title	Response

Bloco de código

language	json

{
    [
        {
      "uf": "",     "latitudeid_tipo_de_atendimento": "",   # ID "longitudedo tipo de atendimento no ERP
            "nome": "",                     # Nome do tipo de atendimento no ERP
            "foneobs": "",        "telefone_comercial": "",     "telefone_celular": "",
    "whatsapp": "",
    "email": "        # Observações
        }
    ]
}

Estado
colour Purple
title PROSPECTO
Estado
colour Yellow
title 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)

Expandir

title	Payload

Bloco de código

language	json

{}

Expandir

title	Response

Bloco de código

language	json

{
    [
        {
            "status_prospeccao": "",    # Código do status no ERP
            "nome": "",                 # Nome do status no ERP
            "obs": ""                   # Observações
        }
    ]
}

Estado
colour Purple
title PROSPECTO
Estado
colour Yellow
title 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.

Expandir

title	Payload

Bloco de código

language	json

{
    "nome": "",                     # Nome do Cliente ou Responsavel pela Empresa
    "razão_social": "",             # Razão do social para clientes PJ (Opcional)
    "tipo_pessoa": "",              # Tipo da pessoa, Física ou Juridica
    "cnpj_cpf": "",                 # CPF ou CNPJ do cliente
    "ie_identidade": "",            # Inscrição Estadual parra clientes PJ (Opcional)
    "data_nascimento": "",          # Data de nascimento do cliente ou do responsável
    "id_revendedor": "",            # Id do revendedor
    "id_origem": "",                # Id da Origem comercial
    "id_vencimento": "",            # Id do Vencimento no ERP
    "cep": "",                      # CEP do cliente
    "endereco_instalação": "",      # Logradouro do endereço de instalação
    "numero_instalação": "",        # Numero do endereço de instalação
    "bairro_instalação": "",        # Bairro do endereço de instalação
    "cidade_instalação": "",        # Cidade do endereço de instalação
    "complemento_instalação": "",   # Complemento do endereço de instalação
    "referencia_instalação": "",    # Referencia do endereço de instalação
    "uf_instalação": "",            # Estado do endereço de instalação
    "endereco_cobranca": "",        # Logradouro do endereço de cobrança
    "numero_cobranca": "",          # Numero do endereço de cobrança
    "bairro_cobranca": "",          # Bairro do endereço de cobrança
    "cidade_cobranca": "",          # Cidade do endereço de cobrança
    "complemento_cobranca": "",     # Complemento do endereço de cobrança
    "referencia_cobranca": "",      # Referencia do endereço de cobrança
    "uf_cobranca": "",              # Estado do endereço de cobrança
    "latitude": "",                 # Latitude da instalação
    "longitude": "",                # Longitude da instalação
    "telefone": "",                 # Telefone residencial
    "celular": "",                  # Celular
    "celular_extra": "",            # Celular extra (geralmente whatsapp)
    "email": "",                    # Email
    "obs": "",                      # Resumo de todas as informações do pedido
    "servicos": [                   # Array serviços contratados/interesse
        {
            "id_servico"            # ID do serviço no ERP
        }
    ],         
    "anexos": [                     # Array de anexos dos documentos anexados ao pedido
        {
            "nome_documento": "",   # Nome do documento
            "formato": "",          # Formato do arquivo
            "base_64" ""    	    # Conteúdo do arquivo em base 64
        }
    ]
}

Expandir

title	Response

Bloco de código

language	json

{
    "id_prospecto": "",      # Id do Prospecto retornado do ERP
    "obs": ""                # Observação ou menssagem do ERP
}

Estado
colour Red
title LEAD
Estado
colour Yellow
title 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

Expandir

title	Payload

Bloco de código

language	json

{
    "nome": "",           # Nome do cliente
    "documento": "",      # Documento do cliente
    "email": "",          # Email do cliente
    "telefone": "",       # Telefone do cliente
    "endereco": "",       # Logradouro do endereço de instalação
    "numero": "",         # Numero do endereço de instalação
    "bairro": "",         # Bairro do endereço de instalação
    "cidade": "",         # Cidade do endereço de instalação
    "estado": "",         # Estado do endereço de instalação
    "CEP": "",            # CEP do endereço de instalação
    "cobertura": "",      # JSON com dados da Cobertura
    "latitude": "",       # Latitude da instalação
    "longitude": "",      # Longitude da instalação
    "revendedor": "",     # Nome do revendedor
    "id_revendedor": "",  # ID do revendedor no ERP
    "extra_data": ""      # Dados extras do lead
}

Expandir

title	Response

Bloco de código

language	json

{
    "id_lead": "",  # ID do lead retornado do ERP
    "obs": ""       # Observação ou menssagem do ERP
}

Estado
title APP
Criar atendimento (POST):

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

Expandir

title	Payload

Bloco de código

language	json

{
    "id_cliente": "",                 # ID do cliente no ERP
    "id_servico": "",                 # ID do serviço do cliente no ERP
    "id_tipo_de_atendimento": "",     # ID do tipo de atendimento escolhido pelo cliente no ERP
    "id_departamento": "",            # ID do departamento escolhido pelo cliente no ERP
    "id_funcionario": "",             # ID do funcionário responsável no ERP
    "email": "",                      # Email do cliente
    "telefone": "",                   # Telefone do cliente
    "assunto": "",                    # Assunto do chamado que o cliente esta abrindo
    "mensagem": "",                   # Mensagem do chamado que o cliente esta abrindo
    "anexo": [                        # Anexos enviados pelo cliente (se a opção estiver liberada)
        {
            "anexo": "",              # Conteúdo do arquivo em base 64
            "obs": "",                # Observação do anexo
            "nome_anexo": ""          # Nome do anexo
        }
    ]
}

Expandir

title	Response

Bloco de código

language	json

{
    "id_atendiemnto": "",   # ID do lead retornado do ERP
    "obs": ""               # Observação ou menssagem do ERP
}

Estado
title APP
Estado
colour Yellow
title TOTEM
Estado
colour Green
title 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

Expandir

title	Payload

Bloco de código

language	json

{
    "id_cliente": "",   # ID do cliente no ERP
    "id_servico": "",   # ID do serviço do cliente no ERP
}

Expandir

title	Response

Bloco de código

language	json

{
    "status": "",   # Status do serviço após a chamada de ativação (se foi ativo ou não)
}

Estado
colour Purple
title Prospecto
Estado
colour Yellow
title 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

Expandir

title	Payload

Bloco de código

language	json

{
    "id_prospecto": "",           # ID do prospecto no ERP
    "status_prospeccao": "",      # ID do status do prospecto no ERP
    "id_revendedor": "",          # ID do revendedor do ERP
    "obs": "",                    # Observações
}

Expandir

title	Response

Bloco de código

language	json

{
    "status": "",   # Status atual do prospecto no ERP
}

Estado
title 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)

Expandir

title	Payload

Bloco de código

language	json

{
    "id_cliente": "",             # ID do cliente no ERP
    "nome": "",                   # Nome do cliente no ERP
    "fantasia": "",               # Nome fantasia do cliente para empresa
    "tipo_pessoa": "",            # Tipo da pessoa, Física ou Juridica
    "cnpj_cpf": "",               # CPF ou CNPJ do cliente
    "ie_identidade": "",          # Inscrição Estadual parra clientes PJ (Opcional)
    "rg_orgao_emissor": "",       # 
    "inscricao_municipal": "",    # 
    "contribuinte_icms": "",      # 
    "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": ""                  # 
}

Expandir

title	Response

Bloco de código

language	json

{
    "status": "",
}

Estado
colour Purple
title Prospecto
Estado
colour Yellow
title 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

Expandir

title	Payload

Bloco de código

language	json

{
    "id_prospecto": "",
    "nome_arquivo": "",
    "arquivo": ""
    "obs": "",
}

Expandir

title	Response

Bloco de código

language	json

{
    "status": "",
}

Estado
title APP
Estado
colour Yellow
title TOTEM
Estado
colour Green
title 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

Expandir

title	Payload

Bloco de código

language	json

{
    "id_cliente": "id_cliente",
    "obsid_fatura": "id_fatura",
    "alerta": ""
}

Expandir

title	Response

Bloco de código

language	json

{
    "status": "",
}

Envio de arquivos (POST)

...

Estado
colour Purple
title Prospecto
Estado
colour Yellow
title TOTEM
Status do Prospecto (GET):

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

Expandir

title	Payload

Bloco de código

language	json

{
    "id_prospecto": "",
    "nome_arquivo": "",
    "arquivo": ""
    "obs": "",
id_prospecto",
}

Expandir

title	Response

Bloco de código

language	json

{
    "status": "",
    "motivo": "motivo_do_cancelamento_ou_rejeição"
}

Comparação de Páginas

Versões comparadas

Versão antiga 8

Nova versão Atual

Chave

EstadotitleAPP EstadocolourYellowtitleTOTEM EstadocolourGreentitleBoleto Pegar infos de clientes (GET):

Pegar boletos abertos/faturas (GET):

EstadotitleAPP EstadocolourYellowtitleTOTEM EstadocolourGreentitleBoleto Pegar boletos abertos/faturas (GET):

Pegar notas fiscais (GET):

Pegar extratos financeiros (GET):

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

EstadotitleAPP EstadocolourYellowtitleTOTEM EstadocolourGreentitle

Boleto Pegar Contratos do Cliente (GET):

EstadotitleAPP Pegar notas fiscais (GET):

EstadotitleAPP Pegar extratos financeiros (GET):

Pegar todos os produtos (GET):

Pegar todos os revendedores (GET):

Pegar todos os funcionários (GET):

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

Pegar todos os vencimentos (GET):

EstadotitleAPP Pegar

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

Pegar todas as cidades (GET):

Pegar todos os tipos de atendimentos (GET):

EstadocolourPurpletitlePROSPECTO EstadocolourRedtitleLEAD EstadocolourYellowtitleTOTEM Pegar todos os produtos (GET):

Criar prospectos (POST):

EstadocolourPurpletitlePROSPECTO EstadocolourRedtitleLEAD EstadocolourYellowtitleTOTEM Pegar todos os revendedores (GET):

EstadotitleAPP EstadocolourPurpletitlePROSPECTO EstadocolourYellowtitleTOTEM Pegar todos os funcionários (GET):

EstadotitleAPP Pegar todos os departamentos (GET):

EstadocolourPurpletitlePROSPECTO EstadocolourYellowtitleTOTEM Pegar todos os vencimentos (GET):

Estado

colourPurpletitle

PROSPECTO EstadocolourRedtitleLEAD EstadocolourYellowtitleTOTEM Pegar as origens comerciais (GET):

Edição do prospecto (PUT):

EstadocolourPurpletitlePROSPECTO EstadocolourRedtitleLEAD EstadocolourYellowtitleTOTEM Pegar todas as cidades (GET):

EstadotitleAPP Pegar todos os tipos de atendimentos (GET):

EstadocolourPurpletitlePROSPECTO EstadocolourYellowtitleTOTEM Pegar todos os status de prospectos (GET):

EstadocolourPurpletitlePROSPECTO EstadocolourYellowtitleTOTEM Criar prospectos (POST):

EstadocolourRedtitleLEAD EstadocolourYellowtitleTOTEM Criar lead (POST):

EstadotitleAPP Criar atendimento (POST):

EstadotitleAPP EstadocolourYellowtitleTOTEM EstadocolourGreentitleBoleto Habilitação provisória (POST):

EstadocolourPurpletitleProspecto EstadocolourYellowtitleTOTEM Edição do prospecto (PUT):

EstadotitleAPP Edição do cliente (PUT):

EstadocolourPurpletitleProspecto EstadocolourYellowtitleTOTEM Envio de arquivos (POST)

EstadotitleAPP EstadocolourYellowtitleTOTEM EstadocolourGreentitleBoleto Baixa na fatura/Sinalização de pagamento (POST)

Envio de arquivos (POST)

EstadocolourPurpletitleProspecto EstadocolourYellowtitleTOTEM Status do Prospecto (GET):

Estado
title APP
Estado
colour Yellow
title TOTEM
Estado
colour Green
title Boleto
Pegar infos de clientes (GET):

Estado
title APP
Estado
colour Yellow
title TOTEM
Estado
colour Green
title Boleto
Pegar boletos abertos/faturas (GET):

Estado
title APP
Estado
colour Yellow
title TOTEM
Estado
colour Green
title

Boleto
Pegar Contratos do Cliente (GET):

Estado
title APP
Pegar notas fiscais (GET):

Estado
title APP
Pegar extratos financeiros (GET):

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

Estado
title APP
Pegar

Estado
colour Purple
title PROSPECTO
Estado
colour Red
title LEAD
Estado
colour Yellow
title TOTEM
Pegar todos os produtos (GET):

Estado
colour Purple
title PROSPECTO
Estado
colour Red
title LEAD
Estado
colour Yellow
title TOTEM
Pegar todos os revendedores (GET):

Estado
title APP
Estado
colour Purple
title PROSPECTO
Estado
colour Yellow
title TOTEM
Pegar todos os funcionários (GET):

Estado
title APP
Pegar todos os departamentos (GET):

Estado
colour Purple
title PROSPECTO
Estado
colour Yellow
title TOTEM
Pegar todos os vencimentos (GET):

colour Purple
title

PROSPECTO
Estado
colour Red
title LEAD
Estado
colour Yellow
title TOTEM
Pegar as origens comerciais (GET):

Estado
colour Purple
title PROSPECTO
Estado
colour Red
title LEAD
Estado
colour Yellow
title TOTEM
Pegar todas as cidades (GET):

Estado
title APP
Pegar todos os tipos de atendimentos (GET):

Estado
colour Purple
title PROSPECTO
Estado
colour Yellow
title TOTEM
Pegar todos os status de prospectos (GET):

Estado
colour Purple
title PROSPECTO
Estado
colour Yellow
title TOTEM
Criar prospectos (POST):

Estado
colour Red
title LEAD
Estado
colour Yellow
title TOTEM
Criar lead (POST):

Estado
title APP
Criar atendimento (POST):

Estado
title APP
Estado
colour Yellow
title TOTEM
Estado
colour Green
title Boleto
Habilitação provisória (POST):

Estado
colour Purple
title Prospecto
Estado
colour Yellow
title TOTEM
Edição do prospecto (PUT):

Estado
title APP
Edição do cliente (PUT):

Estado
colour Purple
title Prospecto
Estado
colour Yellow
title TOTEM
Envio de arquivos (POST)

Estado
title APP
Estado
colour Yellow
title TOTEM
Estado
colour Green
title Boleto
Baixa na fatura/Sinalização de pagamento (POST)

Estado
colour Purple
title Prospecto
Estado
colour Yellow
title TOTEM
Status do Prospecto (GET):