Pular para o conteúdo principal

Documentação da API

POST /get_users

Resumo

Retorna uma lista de usuários com perfil de coletores de uma unidade específica, com base nos parâmetros fornecidos.

Descrição

Este endpoint permite obter uma lista de usuários coletores filtrada pelos parâmetros enviados na requisição, como tokens de acesso e unidade.


Requisição

Body da Requisição

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

ParâmetroTipoObrigatórioDescriçãoExemplo
access_tokenstringSimToken de acesso do usuário.b31643fc-a45f-448c-99ee-736a547f6989
unit_tokenstringSimToken identificador da unidade.e6988e9e-b0c1-410c-ae08-aed7c64ac71f

Exemplo de Requisição

CURL:

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

JSON:

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

Respostas

200 OK

Em caso de sucesso, a resposta segue o formato abaixo:

{
"success": true,
"data": [
{
"name": "Usuário Beta",
"user_token": "aaa4db48-a415-4996-b02d-3203c343ccbc"
}
]
}

4xx e 5xx Erros

Em caso de erro, a resposta contém success como false e uma mensagem de erro, por exemplo:

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