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).aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
unit_tokenstringToken da unidade (obrigatório).aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
searchstringNãoFiltro por nome tanto de pessoa fisica quanto juridica.
registerstringNãoFiltro por CPF/CNPJ.

Requisição de exemplo​

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

Respostas​

200 OK​

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

{
  "success": true,
  "data": [
    {
      "token": "<token>", //token único do contato
      "type": "<type>", // tipo do contato
      "register": "<register>", //cpf para tipo físico e cnpj para tipo jurídico,
      "contact_name": "<contact_name>",
      "company_name": "<company_name>",
      "phone": "<phone>",
      "email": "<email>",
      "observation": "<observation>"
    }
  ]
}

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