Pular para o conteúdo principal

Documentação da API

POST /get_contacts​

Resumo​

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

Descrição​

Utilize este endpoint para obter uma lista de contatos filtradas 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_contacts' -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": "4e34da4a-b4bd-43f7-bdfa-3e894b8f2006", //token único do contato
      "type": "legal", // tipo do contato
      "register": "00000000000000", //cpf para tipo físico e cnpj para tipo jurídico,
      "contact_name": "Padaria Beta",
      "company_name": "Padaria Beta LTDA.",
      "phone": "0000000000",
      "email": "[email protected]",
      "observation": "Padaria"
    }
  ]
}

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