Pular para o conteúdo principal

Documentação da API

POST /get_projects​

Resumo​

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

Descrição​

Utilize este endpoint para obter uma lista de projetos filtrados 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âmetroTipoDescriçãoExemplo
access_tokenstringToken de acesso (obrigatório).b31643fc-a45f-448c-99ee-736a547f6989
unit_tokenstringToken da unidade (obrigatório).e6988e9e-b0c1-410c-ae08-aed7c64ac71f

Requisição de exemplo​

curl -s 'https://portal.fipli.pro/api/v1/get_projects' -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": [
    {
      "token": "baf65ec0-8335-42c1-8899-6de18e2b9bc6", //token único do projeto
      "name": "Renovação design", //nome do projeto
      "observation": "Renovação de design, melhorando a experiência do usuário com a aplicação Fipli.", //descrição do projeto
      "budget": 30000 //orçamento estimado do projeto
    }
  ]
}

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"
}