Documentação da API

POST /get_status

Resumo

Este endpoint retorna status com base nos parâmetros fornecidos pelo usuário.

Descrição

Utilize este endpoint para obter uma lista de status conforme os parâmetros passados na requisição.

---

Requisição

Body da Requisição

O corpo da requisição deve ser um objeto JSON e é obrigatório. A seguir estão os parâmetros aceitos:

Parâmetro	Tipo	Descrição	Exemplo
access_token	string	Token de acesso (obrigatório).	b31643fc-a45f-448c-99ee-736a547f6989
unit_token	string	Token da unidade (obrigatório).	e6988e9e-b0c1-410c-ae08-aed7c64ac71f

---

Requisição de exemplo

curl -s 'https://portal.fipli.pro/api/v1/get_status' -d '{"access_token": "b31643fc-a45f-448c-99ee-736a547f6989", "unit_token": "e6988e9e-b0c1-410c-ae08-aed7c64ac71f"}' -H 'Content-Type: application/json' -H 'userlogged: <jwt>'

{
  "access_token": "b31643fc-a45f-448c-99ee-736a547f6989",
  "unit_token": "e6988e9e-b0c1-410c-ae08-aed7c64ac71f"
}

Respostas

200 OK

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

{
  "success": true,
  "data": [
    {
      "code": "3", // Código identificador do status (pode representar um estágio específico em um fluxo)
      "name": "Aprovado" // Nome descritivo do status
    }
  ]
}

4xx e 5xx Erros

Em caso de erro, success sera igual a false, seguido por uma menssagem de erro, por exemplo:

{ 
  "success": false, 
  "error": "Missing parameters"
}