💡A API Garantia Safra permite consultar informações sobre os benefícios do programa Garantia-Safra, voltado a agricultores familiares que perderam suas safras devido à estiagem ou excesso hídrico.


Introdução

A API Garantia Safra oferece acesso a dados detalhados sobre benefícios concedidos a agricultores familiares, incluindo valores recebidos e informações associadas ao programa. É ideal para análises de risco de crédito, compliance e processos de onboarding de fornecedores.


URL Base

A API está hospedada no seguinte endereço:

https://api.directd.com.br

Endpoint

GET /api/GarantiaSafra

Descrição: Endpoint para realizar a consulta de benefícios do programa Garantia-Safra.

Nota: Esta consulta não gera comprovantes.


Autenticação

Para acessar esta API, é necessário fornecer um token de autenticação.

Regras de Autenticação:

  1. O token deve ser enviado como parâmetro na URL da requisição.
  2. O token é obrigatório para realizar consultas.

Campos da API

Dados do Beneficiário

  • Nome: Nome completo do beneficiário.
  • CPF: Cadastro de Pessoa Física.
  • NIS: Número de Identificação Social do beneficiário.

Benefícios

  • Lista de Benefícios:
    • Número do Registro: Número do registro do benefício.
    • Data: Data do benefício.
    • Valor: Valor do benefício recebido.
    • Município: Município onde o benefício foi registrado.
    • UF: Unidade Federativa do município.

Parâmetros

NomeTipoObrigatórioDescrição
CPFstringNãoCPF do beneficiário. Pode ser enviado com ou sem formatação.
NISstringNãoNIS (Número de Identificação Social) do beneficiário.
TOKENstringSimToken de autenticação necessário para a consulta.

Exemplos de Requisição

Usando cURL

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

Respostas

Sucesso (200)

Exemplo de Resposta

{
  "metaDados": {
    "consultaNome": "Garantia Safra",
    "consultaUid": "safra-123456",
    "usuario": "João",
    "mensagem": "Sucesso",
    "apiVersao": "v3",
    "tempoExecucaoMs": 300
  },
  "retorno": {
    "nome": "José da Silva",
    "nis": "1234567890",
    "cpf": "123.456.789-09",
    "beneficios": [
      {
        "numeroRegistro": 1,
        "data": "2024-01-15",
        "valor": "R$ 850,00",
        "municipio": "São José",
        "uf": "SC"
      }
    ]
  }
}

9. Erros Comuns

CódigoDescrição
400Requisição inválida: parâmetros incorretos.
401Não autenticado: token inválido ou ausente.
403Não autorizado: saldo insuficiente para realizar a consulta.
404Não encontrado: registro não localizado.
408Tempo esgotado: consulta não foi concluída no prazo.
500Erro interno: falha no processamento da consulta.
503Serviço em manutenção: indisponível temporariamente.

10. Notas Importantes

  • Utilize apenas um parâmetro de consulta por vez (CPF ou NIS).
  • Certifique-se de que o token de autenticação está ativo e válido.