Referência da API da Plataforma SAAS CRM Wukong

Introdução

Esta referência documenta endpoints de API da plataforma SAAS CRM Wukong (versão Java 11.0), obtidos por inspeção de tráfego de rede. Os detalhes das respostas e parâmetros podem estar incompletos. É necessário registrar uma conta gratuita no SAAS e familiarizar-se com a lógica de negócios subjacente.

  • A maioria dos endpoints suporta os métodos GET e POST.
  • A autenticação é feita usando um nome de usuário e senha no endpoint de login. Um token de administrador (Admin-Token) é retornado na resposta. Este token deve ser enviado no cabeçalho das requisições subsequentes no formato: Admin-Token=....

Conceitos Básicos do CRM

  • CRM (Gestão de Relacionamento com o Cliente): Plataforma para gerenciar leads, descobrir oportunidades, acompanhar clientes e facilitar fechamentos.
  • Lead (Contato): Informações iniciais coletadas de potenciais clientes que requerem verificação.
  • Cliente: Empresa ou entidade com necessidade potencial de compra.
  • Contato: Pessoa de ligação dentro de uma organização cliente.
  • Oportunidade (Deals): Intenção de compra específica de um cliente ou lead.

URL Base: https://www.72crm.com

Endpoints de Autenticação e Utilidade

Login

URL: /api/login
Método: POST/GET
Content-Type: application/x-www-form-urlencoded

Exemplo de Requisição

user=admin_user&pass=senha_segura
Parâmetro Descrição
user Nome de usuário
pass Senha

Exemplo de Resposta

{
    "code": 0,
    "Admin-Token": "a1b2c3d4e5f67890...",
    "user": {
        "userId": 28510,
        "username": "admin_user",
        "realname": "Admin User",
        "companyId": "1314450786960412672",
        "companyName": "Minha Empresa",
        "status": 1,
        "isAdmin": true
    }
}

Consultar Opções de Campos

Retorna as opções disponíveis para campos de formulário, como fontes de lead.

URL: /api/field/queryField
Método: POST/GET
Content-Type: application/x-www-form-urlencoded
Autenticação: Cabeçalho Admin-Token

Exemplo de Requisição

fieldType=1
Parâmetro Descrição
fieldType Tipo: 1. Lead, 2. Cliente, 3. Contato, 4. Produto, 5. Oportunidade

Exemplo de Resposta

{
    "code": 0,
    "data": [
        {
            "fieldId": 2398372,
            "name": "Origem do Lead",
            "formType": "select",
            "setting": ["Promoção", "Mecanismo de Busca", "Publicidade"]
        }
    ]
}

Consultar Cenários de Filtro

Obtém cenários de filtro pré-definidos para listas de leads/clientes.

URL: /api/scene/queryScene
Método: POST/GET
Content-Type: application/x-www-form-urlencoded
Autenticação: Cabeçalho Admin-Token

Exemplo de Requisição

entityType=1
Parâmetro Descrição
entityType Tipo: 1. Lead, 2. Cliente, etc.

Exemplo de Resposta

{
    "code": 0,
    "data": [
        {
            "sceneId": 434349,
            "name": "Todos os Leads",
            "isSystem": 1,
            "isDefault": 0
        }
    ]
}

Endpoints de Leads

Criar ou Atualizar Lead

URL: /api/CrmLeads/addOrUpdate
Método: POST/GET
Content-Type: application/json
Autenticação: Cabeçalho Admin-Token

Exemplo de Corpo da Requisição

{
    "entity": {
        "lead_title": "Lead Novo Prospect",
        "phone": "+55 11 91234-5678",
        "source": "Site"
    }
}
Parâmetro Descrição
leadId ID do lead. Se presente, atualiza. Senão, cria.
lead_title Título ou nome do lead.
phone Número de telefone principal.
source Origem do lead.

Listar Leads

Retorna uma lista paginada de leads, com suporte a filtros por cenário e filtros avançados.

URL: /api/CrmLeads/queryPageList
Método: POST/GET
Content-Type: application/json
Autenticação: Cabeçalho Admin-Token

Exemplo de Corpo da Requisição

{
    "pageNum": 1,
    "pageSize": 20,
    "filterData": {
        "phone": {"op": "like", "value": "1234"}
    },
    "sceneId": null
}
Parâmetro Descrição
pageNum Número da página.
pageSize Itens por página.
filterData Objeto com condições de filtro avançadas.
sceneId ID de um cenário de filtro salvo.

Converter Lead em Cliente

URL: /api/CrmLeads/transformToCustomer
Método: POST/GET
Content-Type: application/x-www-form-urlencoded
Autenticação: Cabeçalho Admin-Token

Exemplo de Requisição

leadIds=101,102
Parâmetro Descrição
leadIds IDs dos leads, separados por vírgula.

Endpoints de Clientes

Criar ou Atulaizar Cliente

URL: /api/CrmCustomer/saveOrUpdate
Método: POST/GET
Content-Type: application/json
Autenticação: Cabeçalho Admin-Token

Exemplo de Corpo da Requisição

{
    "company_name": "Tech Solutions Ltda.",
    "primary_contact": "Maria Silva",
    "email_contato": "maria@techsolutions.com"
}
Parâmetro Descrição
customerId ID do cliente para atualização.
company_name Nome da empresa cliente.
primary_contact Nome do contato principal.
email_contato E-mail do contato.

Listar Clientes

URL: /api/CrmCustomer/list
Método: POST/GET
Content-Type: application/json
Autenticação: Cabeçalho Admin-Token

Exemplo de Corpo da Requisição

{
    "page": 1,
    "limit": 15,
    "filters": {
        "city": "São Paulo",
        "status": "active"
    }
}

Transferir Propriedade do Cliente

URL: /api/CrmCustomer/reassign
Método: POST/GET
Content-Type: application/x-www-form-urlencoded
Autenticação: Cabeçalho Admin-Token

Exemplo de Requisição

customerIds=5001,5002&newOwnerUser=305
Parâmetro Descrição
customerIds IDs dos clientes.
newOwnerUser ID do novo usuário responsável.

Endpoints de Contatos

Criar ou Atualizar Contato

URL: /api/CrmContacts/saveOrUpdate
Método: POST/GET
Content-Type: application/json
Autenticação: Cabeçalho Admin-Token

Exemplo de Corpo da Requisição

{
    "contact_name": "João Oliveira",
    "company_id": 5001,
    "job_title": "Gerente de Compras",
    "mobile": "+55 21 98765-4321"
}

Listar Contatos

URL: /api/CrmContacts/list
Método: POST/GET
Content-Type: application/json
Autenticação: Cabeçalho Admin-Token

Endpoints de Oportunidades (Deals)

Criar ou Atualizar Oportunidade

URL: /api/CrmBusiness/createOrUpdate
Método: POST/GET
Content-Type: application/json
Autenticação: Cabeçalho Admin-Token

Exemplo de Corpo da Requisição

{
    "deal_name": "Projeto de Implementação ERP",
    "amount": 75000.00,
    "stage": "Proposal",
    "customer_id": 5001,
    "expected_close_date": "2024-06-30"
}

Listar Oportunidades

URL: /api/CrmBusiness/listDeals
Método: POST/GET
Content-Type: application/json
Autenticação: Cabeçalho Admin-Token

Exemplo de Corpo da Requisição

{
    "pagination": {"currentPage": 1, "perPage": 10},
    "sortBy": "amount_desc",
    "searchTerm": "ERP"
}

Tags: CRM API REST Wukong CRM Java SAAS Cliente-Contatos

Publicado em 6-4 00:21 por Thomas