Orientações e respostas da equipe da Direct Data

/api/AuxilioReconstrucao

💡 O endpoint /api/AuxilioReconstrucao permite consultar dados de beneficiários do programa Auxílio Reconstrução, destinado a famílias desalojadas ou desabrigadas no Rio Grande do Sul devido às enchentes. A consulta retorna informações sobre os benefícios concedidos, membros da família e localização.

Introdução

A API Auxílio Reconstrução é uma ferramenta essencial para validar beneficiários de programas assistenciais, sendo útil para organizações públicas e privadas no acompanhamento e auditoria da distribuição dos auxílios.

Ela permite:

• Consultar dados do beneficiário (CPF/NIS);
• Identificar valor, data e local do benefício recebido;
• Validar número de membros da família cadastrados no programa.

URL Base

A API está hospedada no seguinte endereço:

https://apiv3.directd.com.br

Endpoint

GET /api/AuxilioReconstrucao

Esse endpoint retorna informações sobre beneficiários do Auxílio Reconstrução com base no CPF ou NIS informado.

Regras

1. Deve ser enviado apenas um identificador por requisição (CPF ou NIS).
2. Esta consulta não gera comprovante PDF.

Autenticação

A autenticação é feita utilizando um TOKEN. Sem um token válido, o acesso será negado (401).

Regras de Autenticação

1. O TOKEN deve ser incluído como parâmetro obrigatório.
2. Caso o token seja inválido ou expirado, entre em contato pelo e-mail: suporte@directd.com.br.

Campos da API

Dados Retornados

• CPF: Cadastro de Pessoa Física do beneficiário.
• NIS: Número de Identificação Social.
• Nome: Nome completo do beneficiário.
• Quantidade de Pessoas na Família: Total de membros cadastrados.
• Benefícios:
  • Data: Data de concessão do benefício.
  • Valor: Valor recebido.
  • Município: Cidade do beneficiário.
  • UF: Unidade federativa do município.

Parâmetros

Exemplo de Requisição

Usando cURL

'https://apiv3.directd.com.br/api/AuxilioReconstrucao?CPF=12345678909&TOKEN=seu_token_aqui'

Respostas

Sucesso (200)

A consulta foi realizada com sucesso e retorna os dados do beneficiário.

Exemplo de Resposta

{
  "metaDados": {
    "consultaNome": "Auxílio Reconstrução",
    "consultaUid": "direct-123456",
    "usuario": "Usuario",
    "mensagem": "Sucesso",
    "apiVersao": "v3",
    "tempoExecucaoMs": 2500
  },
  "retorno": {
    "nome": "MARIA SILVA",
    "nis": "12345678901",
    "cpf": "123.456.789-09",
    "quantidadePessoasFamilia": 4,
    "beneficios": [
      {
        "data": "01/03/2024",
        "valor": "800,00",
        "municipio": "Porto Alegre",
        "uf": "RS"
      }
    ]
  }
}

Erros Comuns

Notas Importantes

• É obrigatório informar pelo menos CPF ou NIS na consulta.
• Esta API não gera comprovantes PDF.
• O token é necessário em todas as requisições.
• Certifique-se de possuir saldo suficiente antes de realizar a consulta.
• Para dúvidas ou suporte, entre em contato pelo e-mail: suporte@directd.com.br.