Orientações e respostas da equipe da Direct Data

/api/APFRural

💡 O endpoint /api/APFRural permite realizar consultas sobre Autorização Provisória de Funcionamento (APF) Rural, um ato administrativo declaratório que permite o exercício provisório das atividades de agricultura e pecuária extensiva e semiextensiva em áreas rurais. Esta documentação detalhada oferece informações sobre como autenticar, enviar requisições, interpretar respostas e gerenciar erros durante a integração.

Introdução

A Autorização Provisória de Funcionamento (APF) Rural é um documento essencial para produtores rurais, pois:

• Substitui a Licença Ambiental Única (LAU)
• É necessário para obtenção de linhas de crédito rural em instituições financeiras
• Permite o exercício provisório de atividades agrícolas e pecuárias

Este endpoint é fundamental para sistemas que necessitam verificar:

• Situação de propriedades rurais
• Conformidade ambiental
• Análise de crédito rural
• Compliance e ESG

URL Base

A API está hospedada no seguinte endereço:

https://apiv3.directd.com.br

Endpoint

GET /api/APFRural

Este endpoint retorna informações detalhadas sobre as Autorizações Provisórias de Funcionamento Rural, exigindo autenticação por meio de um TOKEN válido.

Autenticação

Para utilizar este endpoint, você deve incluir o parâmetro TOKEN na URL. O TOKEN serve para autenticar o usuário e garantir o acesso aos recursos. Sem um TOKEN válido, a API retornará um erro de autenticação (401).

Regras de Autenticação

1. O TOKEN é obrigatório para todas as consultas.
2. O IP de origem da requisição deve estar autorizado no sistema.
3. Em caso de dúvidas ou problemas com o TOKEN, entre em contato com o suporte técnico pelo e-mail: suporte@directd.com.br.

Campos da API

• Área Total: Área total do imóvel rural
• Área Utilizada: Área em uso para atividades agropecuárias
• Atividade: Tipo de atividade desenvolvida na propriedade
• CAR: Número do Cadastro Ambiental Rural
• Coordenadas: Localização geográfica do imóvel
• Data da Consulta: Data em que a consulta foi realizada
• Data de Emissão: Data de emissão da APF
• Data de Validade: Data de vencimento da APF
• Documento: Identificação do proprietário/responsável
• Documento Consultado: CNPJ/CPF utilizado na consulta
• Imóvel: Nome/identificação do imóvel rural
• Informações Adicionais: Dados complementares
• Lista de Autorizações: Relação de APFs associadas
• Município: Localização do imóvel
• Nome: Nome do proprietário/responsável
• Número da APF: Identificador único da autorização
• Proprietário: Dados do proprietário do imóvel
• Quantidade de Autorizações: Total de APFs encontradas
• Responsável: Dados do responsável técnico
• Situação do CAR: Status atual do CAR
• Status: Situação atual da APF

Parâmetros

*É necessário informar pelo menos um dos parâmetros: CNPJ, CPF, NumeroAPF ou NumeroCAR.

Exemplo de Requisição

Usando cURL

'https://apiv3.directd.com.br/api/APFRural?CNPJ=DOCUMENTO_AQUI&TOKEN=SEU_TOKEN_AQUI'

Respostas

A API retorna respostas em formato JSON com os seguintes códigos de status:

Sucesso (200)

Essa resposta é retornada quando a consulta é processada corretamente.

{
  "metaDados": {
    "consultaNome": "APF Rural",
    "consultaUid": "direct-uid-123456",
    "chave": "CNPJ=33333333000199;",
    "usuario": "UsuarioTeste",
    "mensagem": "Consulta realizada com sucesso.",
    "ip": "0.0.0.0",
    "resultadoId": 1,
    "resultado": "Sucesso",
    "apiVersao": "v3",
    "gerarComprovante": false,
    "urlComprovante": null,
    "assincrono": false,
    "data": "05/12/2024 16:09:04",
    "tempoExecucaoMs": 120
  },
  "retorno": {
    "documentoConsultado": "33333333000199",
    "dataConsulta": "05/12/2024",
    "quantidadeAutorizacoes": 1,
    "autorizacoes": [
      {
        "imovel": "Fazenda Exemplo",
        "proprietario": {
          "nome": "João da Silva",
          "documento": "33333333000199"
        },
        "responsavel": {
          "nome": "Maria Técnica",
          "documento": "12345678900"
        },
        "car": "MT123456789",
        "situacaoCAR": "Ativo",
        "apf": "APF123456",
        "dataEmissao": "01/01/2024",
        "dataValidade": "31/12/2024",
        "status": "Ativo",
        "municipio": "Cuiabá",
        "atividade": "Pecuária extensiva",
        "informacoesAdicionais": {
          "coordenadas": "-15.601411, -56.097892",
          "areaTotal": "1000 ha",
          "areaUtilizada": "800 ha"
        }
      }
    ]
  }
}

Em Processamento (202)

Retornado quando a consulta assíncrona ainda está em processamento.

{
  "metaDados": {
    "consultaNome": "APF Rural",
    "consultaUid": "direct-uid-789012",
    "chave": "CNPJ=33333333000199;",
    "usuario": "UsuarioTeste",
    "mensagem": "Consulta em processamento",
    "ip": "0.0.0.0",
    "resultadoId": 2,
    "resultado": "Em Processamento",
    "apiVersao": "v3",
    "gerarComprovante": false,
    "urlComprovante": null,
    "assincrono": true,
    "data": "05/12/2024 16:09:04",
    "tempoExecucaoMs": 1000
  },
  "retorno": null
}

Erro de Autenticação (401)

Retornado quando o TOKEN fornecido é inválido ou o IP não está autorizado.

{
  "metaDados": {
    "consultaNome": "APF Rural",
    "consultaUid": "direct-uid-654321",
    "chave": "CNPJ=33333333000199;",
    "usuario": null,
    "mensagem": "IP ou Token inválido. Verifique.",
    "ip": "0.0.0.0",
    "resultadoId": 3,
    "resultado": "Não Autorizado",
    "apiVersao": "v3",
    "gerarComprovante": false,
    "urlComprovante": null,
    "assincrono": false,
    "data": "05/12/2024 16:09:04",
    "tempoExecucaoMs": 1
  },
  "retorno": null
}

Códigos de Resposta

Notas Importantes

• É necessário informar pelo menos um dos parâmetros de busca: CNPJ, CPF, NumeroAPF ou NumeroCAR
• Os parâmetros podem ser enviados com ou sem formatação
• O serviço de geração de comprovante em PDF tem custo adicional de 50% sobre o valor da consulta
• Para dúvidas ou suporte, contate suporte@directd.com.br
• Certifique-se de que o IP da requisição está previamente autorizado