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

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

...

{
    "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": ""
}

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 id do cliente

...

{
    [
        {
            "id_instalacao": "",  
            "cep": "",
            "endereco": "",
            "numero": "",
            "complemento": "",
            "bairro": "",
            "cidade": "",
            "uf": "",
            "latitude": "",
            "longitude": "",
            "obs": "",
            "servicos": [
                {
                    "id_servico": "",
                    "nome": "",
                    "descricao": "",
                    "valor": "",
                    "status": "",
                    "obs": ""
                }
            ]
        }
    ]
}

Estado
colour

...

Purple title PROSPECTO

Estado
colour Red title LEAD

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

...

{
    [
        {
            "id_servico": "",
            "nome": "",
            "descricao": "",
            "valor": "",
            "obs": ""
        }
    ]
}

Estado
colour

...

Purple title PROSPECTO

Estado
colour Red title LEAD

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

...

{
    [
        {
            "id_revendedor": "",
            "nome": "",
            "obs": ""
        }
    ]
}

Estado
colour

...

Purple title PROSPECTO

Estado
title APP

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

...

{
    [
        {
            "id_departamento": "",
            "nome": "",
            "obs": ""
        }
    ]
}

Estado
colour

...

Purple title PROSPECTO

Pegar todos os vencimentos (GET):

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

...

{
    [
        {
            "id_vencimento": "",
            "data": "",
            "obs": ""
        }
    ]
}

Estado
colour

...

Purple title PROSPECTO

Estado
colour Red title LEAD

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)

...

{
    [
        {
            "id_origem": "",
            "nome": "",
            "obs": ""
        }
    ]
}

Estado
colour

...

Purple title PROSPECTO

Estado
colour Red title LEAD

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.

...

{
    [
        {
            "id_tipo_de_atendimento": "",
            "nome": "",
            "obs": ""
        }
    ]
}

Estado
colour

...

Purple title PROSPECTO

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)

...

{
    [
        {
            "status_prospeccao": "",
            "nome": "",
            "obs": ""
        }
    ]
}

Estado
colour

...

Purple title PROSPECTO

Criar prospectos (POST):

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

...

{
    "status": "",
}

Estado
colour

...

Purple title Prospecto

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

...

{
    "status": "",
}

Estado
colour

...

Purple title Prospecto

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

...

{
    "status": "",
}

Estado
colour

...

Purple title Prospecto

Status do Prospecto (GET):

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

...