Documentação da API
POST /disable_category
Resumo
Este endpoint permite desativar uma categoria existente em uma unidade específica.
Descrição
Utilize este endpoint para desativar uma categoria cadastrada anteriormente, tornando-a inativa para a unidade informada. A categoria não será excluída do banco de dados, apenas marcada como inativa.
Requisição
Body da Requisição
O corpo deve ser um objeto JSON com os seguintes parâmetros:
| Parâmetro | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|
access_token | string | Sim | Token de autenticação do usuário. | aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee |
unit_token | string | Sim | Token identificador da unidade. | aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee |
id_token | string | Sim | Token identificador da categoria a ser desativada. | aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee |
Exemplo de Requisição
Curl
curl -X POST 'https://portal.fipli.pro/api/v1/disable_category' \
-H 'Content-Type: application/json' \
-d '{
"access_token": "<access_token>",
"unit_token": "<unit_token>",
"id_token": "<id_token>"
}'
Resposta
200 OK
Desativação realizada com sucesso.
{
"success": true,
"message": "Category disabled successfully"
}
Erros Comuns
| Status | Mensagem | Descrição |
|---|---|---|
400 | "Missing parameters" | Algum parâmetro obrigatório não foi enviado na requisição. |
403 | "Invalid data" | Token inválido ou não autorizado. |
404 | "Category not found" | A categoria com o token fornecido não foi encontrada. |
500 | "Something went wrong. Please try again later." | Erro interno no servidor. |
Observações
- A desativação é lógica, a categoria permanece no banco de dados.
- A operação é vinculada à unidade informada.
- Certifique-se de que os tokens utilizados estejam válidos e atualizados.