Gerenciamento de Clientes (manageCustomers)

Este endpoint é responsável pelo CRUD (Criação, Leitura, Atualização e Exclusão) de clientes (assinantes), incluindo a gestão de seus dados cadastrais, financeiros e permissões de usuários.

Autenticação e Base URL

Todas as requisições requerem a passagem das credenciais de API diretamente na URL. Formato Base: {{base_url}}/api/ManageCustomers/{{api_token}}/{{api_key}}/

Mapeamento de Métodos

• GET: Ler dados
• PUT: Criar novo
• POST: Atualizar existente
• DELETE: Excluir

1. Obter Cliente (Ler)

Retorna os dados completos do cliente e de seus usuários associados.

• Método: GET
• Rota: {{base_url}}/api/ManageCustomers/{{api_token}}/{{api_key}}/{id}

• Parâmetros de Rota:

• {id} (int): ID do Cliente que deseja consultar.

Exemplo de Resposta:

{
    "error": 0,
    "reason": "OK",
    "records": 1,
    "data": [
        {
            "id": "210",
            "nome_fantasia": "TESTE",
            "users": [
                {
                    "id": "235",
                    "username": "hemershontestando",
                    "api_access": "0"
                }
            ]
        }
    ]
}

2. Atualizar Cliente (Update)

Atualiza os dados de um cliente e suporta a atualização de permissões de usuários (ex: api_access).

• Método: POST
• Rota: {{base_url}}/api/ManageCustomers/{{api_token}}/{{api_key}}/{id}

• Parâmetros de Rota:

• {id} (int): ID do Cliente que será alterado.

Exemplo de Payload:

{
    "nome_fantasia": "NOVO NOME",
    "finance": {
        "limite_credito": 150.00
    },
    "users": [
        {
            "id": 235,
            "api_access": 1
        }
    ]
}

Observação: Para atualizar o usuário, ele obrigatoriamente precisa estar vinculado ao {id} de cliente passado na URL.

3. Criar Cliente (Create)

Cria um novo cliente, seu perfil financeiro e o usuário principal de acesso.

• Método: PUT
• Rota: {{base_url}}/api/ManageCustomers/{{api_token}}/{{api_key}}/ (sem ID no final)

Exemplo de Payload:

{
    "id_hie": 206,
    "id_origem": 1,
    "id_vinculo": 1,
    "id_vendedor": 1,
    "nome_fantasia": "EMPRESA TESTE",
    "razao_social": "EMPRESA TESTE LTDA",
    "cpf": "00000000000191",
    "rg": "ISENTO",
    "cep": "00000000",
    "endereco": "Rua Exemplo",
    "cidade": "São Paulo",
    "telefone": "11999999999",
    "email": "contato@empresa.com",
    "finance": {
        "tipo_tar": 1,
        "id_plano": 21
    },
    "user": {
        "username": "usuario_master",
        "password": "senhaSegura123"
    }
}

4. Excluir Cliente (Delete)

Deleta permanentemente um cliente e limpa as crons associadas.

• Método: DELETE
• Rota: {{base_url}}/api/ManageCustomers/{{api_token}}/{{api_key}}/{id}

• Parâmetros de Rota:

• {id} (int): ID do Cliente a ser excluído.

Exemplo de Resposta:

{
    "error": 0,
    "reason": "OK"
}