Agora no Bluesoft ERP, é possível consultar, cadastrar e alterar o status de categorias de cliente via API
O objetivo deste desenvolvimento foi implementar a consulta, cadastro e atualização de status de categorias de clientes via API.
Consulta de Categorias de Clientes (GET)
Este endpoint permite consultar todas as categorias de clientes cadastradas.
| Método HTTP | GET |
| Endpoint | /crm/clientes/categorias |
| Permissão Necessária | 4370 – API Categoria de Clientes (Consultar) |
Parâmetros de Consulta (Query Params)
O endpoint aceita paginação e filtragem por chave:
| Parâmetro | Tipo | Obrigatoriedade | Descrição |
categoriaClienteKey | Integer (int) | Opcional | O identificador único da categoria do cliente. Permite filtrar por uma categoria específica. |
currentPage | Integer (int) | Opcional | Índice da página atual (base-zero). |
pageSize | Integer (int) | Opcional | Quantidade de itens por página. |
Estrutura de Retorno (Exemplo JSON) Em caso de sucesso (200 OK), é retornado um array de categorias, contendo: categoriaClienteKey, codigo, descricao, e ativo.
{
"currentPage": 0,
"pageSize": 30,
"data": [
{
"categoriaClienteKey": 41,
"codigo": 5,
"descricao": "CRM",
"ativo": true
}
]
}Cadastro de Nova Categoria de Cliente (POST)
Permite a inclusão de uma nova categoria de cliente.
| Método HTTP | POST |
| Endpoint | /crm/clientes/categorias |
| Permissão Necessária | 4371 – API Categoria de Clientes (Incluir) |
Corpo da Requisição (Request Body – JSON)
Todos os campos listados abaixo são obrigatórios para a criação.
| Campo (API) | Tipo | Obrigatoriedade | Restrições/Detalhes |
codigo | Integer (int2) | Sim | Máximo de 5 dígitos. Deve ser Único. |
descricao | String (varchar) | Sim | Máximo de 20 caracteres. Deve ser Única. |
status | Boolean (bool) | Sim | true (Ativo) ou false (Inativo). |
Exemplo de JSON:
{
"codigo": 5,
"descricao": "CRM",
"ativo": true
}Atualização de Status de Categoria de Cliente (PUT)
Este endpoint é específico para ativar ou inativar uma categoria de cliente existente.
| Método HTTP | PUT |
| Endpoint | /crm/clientes/categorias/{categoriaClienteKey}/status |
| Permissão Necessária | 4372 – API Categoria de Clientes (Alterar) |
Exemplo de JSON:
{
"status": false
}Parâmetro de Caminho (Path Param)
| Parâmetro | Tipo | Obrigatoriedade | Descrição |
categoriaClienteKey | Integer (int) | Sim | O identificador único da categoria a ser atualizada. |
Corpo da Requisição (Request Body – JSON)
A requisição deve conter apenas o campo status:
| Campo | Tipo | Obrigatoriedade | Observações |
status | Boolean | Sim | O novo status (true para Ativo, false para Inativo). |
Para conhecer mais sobre como é a utilização dessa ferramenta, clique aqui.
Para saber mais sobre a utilização das APIs do ERP, clique aqui.