Pular para conteúdo

Documentação integração PEFIN - Target Informações


Contato

Site Target Informações

Para suporte ao desenvolvedor, encaminhar um e-mail para analise.sistema@targetinformacoes.com.br ou ligar para o atendimento: (62) 3924-9002 | 0800 607 9002


Introdução

A integração PEFIN foi criada para permitir que máquinas consigam se comunicar com os nossos sistemas, permitindo assim fazer a inclusão, exclusão, gerenciamento e manutenção de registros de inadimplentes junto a base de dados da Serasa Experian.

O requisito básico para que seja feito a utilização dessa API, é conhecimento em integração entre sistemas, utilização oAuth2, Rest e uma conexão com a internet.

Por se tratar de uma integração via HTTP usando Rest qualquer linguagem de programação ou ferramenta que possa acessar e processar o protocoloco HTTP irá conseguir fazer uso dessa integração.

O registro do pefin é divido em 3 partes:

  • Negativado: a pessoa/empresa que contraiu a dívida; este é o responsável principal pelo seu pagamento, podendo ter uma ou várias dívidas.
  • Coobrigado/fiador: é a pessoa/empresa que avalisou a operação, em uma dívida, pode ter um ou vários coobrigados e o mesmo é relacionado a dívida e ao negativado.
  • Débito/dívida: são as informações sobre o pagamento que deixou de ser feito, como valores, nosso número e outras informações que identificada cada débito. Lembrando que uma dívida pode estar relacionado com vários negativados e/ou coobrigado.

Operações básicas

Como citado anteriormente, essa API segue o padrão Rest, portanto a operação do HTTP é que definirá a ação

Verbo Uso
GET Listar ou detalhar o(s) registros
POST Cria um novo registro
PUT Atualiza todo o registro
PATCH Atualiza parte da informação do registro
DELETE Apaga o registro

Por padronização, todos os endpoints terminam com "/" (barra), caso não seja informado, poderá receber um retorno 301 em operações GET, e em algumas operações como o POST 404


Código de erro

Os códigos de retorno segue o padrão Rest/HTTP, abaixo, segue alguns executados em determinadas situações:

Código Motivo/Situação
200 A operação foi recebida e processada com sucesso
201 A solicitação de criar um novo registro foi executada com sucesso
204 Sem novas alterações ou a resposta não tem dados
301 Redirecionamento permanente para outra URL/Endpoint
400 Erro de validação ao processar a requisição
401/403 Você está tentando acessar um endpoint ou executar uma ação que não tem permissão
404 Recurso não encontrado
500 Erro interno

OBS: Existem outros códigos que são gerados em outras situações, porém, esses são os que emitem com mais frequência, para conhecer outros códigos, tem um execelente artigo da Mozilla MDN aqui.


Servidores

Servidor de homologação: https://homolog-pefin.targetinformacoes.com

Servidor de produção: https://pefin.targetinformacoes.com