Documentação da API

POST /get_products_and_services

Resumo

Retorna uma lista de produtos e serviços com base nos parâmetros fornecidos na requisição.

Descrição

Este endpoint permite consultar produtos e serviços disponíveis, filtrados pelos tokens de acesso e unidade fornecidos. É ideal para integração com sistemas que necessitam listar itens disponíveis para uma unidade organizacional específica.

---

Requisição

Método e URL

• Método: POST
• URL: https://portal.fipli.pro/api/v1/get_products_and_services

Cabeçalhos

Cabeçalho	Valor	Descrição
Content-Type	application/json	Tipo de conteúdo da requisição.

Corpo da Requisição

O corpo da requisição deve ser um objeto JSON. Os parâmetros obrigatórios são:

Parâmetro	Tipo	Descrição	Exemplo
access_token	string	Token de acesso do usuário (obrigatório).	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
unit_token	string	Token da unidade organizacional (obrigatório).	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
search	string	Filtro por descrição (opcional).	descrição
type	string	Filtro por tipo: service, product, all (opcional).	all

Exemplo de Requisição

curl -X POST 'https://portal.fipli.pro/api/v1/get_products_and_services' \
  -H 'Content-Type: application/json' \
  -d '{
    "access_token": "<access_token>",
    "unit_token": "<unit_token>"
  }'

{
  "access_token": "<access_token>",
  "unit_token": "<unit_token>"
}

---

Respostas

200 OK - Sucesso

Retorna uma lista de produtos e serviços no seguinte formato:

{
  "success": true,
  "data": [
    {
      "token": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "description": "Produto 2",
      "type": "product",
      "monetary_value": "150.00"
    }
  ]
}

Descrição dos campos da resposta:

• success: Booleano indicando o sucesso da requisição (true).
• data: Array de objetos contendo os produtos e serviços.
  • token: Identificador único do item.
  • description: Nome ou descrição do produto ou serviço.
  • type: Tipo do item (product ou service).
  • monetary_value: Valor unitário do item (string, formato decimal com duas casas).

Erros (4xx e 5xx)

Em caso de erro, a resposta terá o seguinte formato:

{
  "success": false,
  "error": "Descrição do erro"
}

Erros comuns:

• 400 Bad Request: "Missing parameters" - Parâmetros obrigatórios (access_token ou unit_token) ausentes.
• 401 Unauthorized: "Invalid token" - Tokens fornecidos são inválidos ou expirados.
• 500 Internal Server Error: "Server error" - Erro interno no servidor.

---