/api/DAPPessoaJuridica
💡 A API DAP - Declaração de Aptidão ao Pronaf fornece informações sobre organizações agrícolas familiares no Brasil. A DAP permite acesso a benefícios do Programa Nacional de Fortalecimento da Agricultura Familiar (Pronaf), como crédito rural e assistência técnica, além de informações sobre composição societária e propriedades rurais.
Introdução
A API DAP - Declaração de Aptidão ao Pronaf - Pessoa Jurídica é uma ferramenta essencial para analisar dados de organizações agrícolas familiares, incluindo informações sobre sua composição societária, propriedades, e dados relacionados a benefícios do Pronaf.
A API suporta processamento assíncrono, o que significa que algumas consultas podem não retornar resultados imediatamente. Nestes casos, a API retornará um código 201 ou 202 indicando que a requisição está sendo processada. O status da consulta pode ser acompanhado através dos metadados retornados na resposta.
O valor atual da consulta é de R$ 0,72, com possibilidade de gerar comprovante em PDF (adicional de 50% do valor da consulta).
URL Base
A API está hospedada no seguinte endereço:
https://apiv3.directd.com.br
Endpoint
GET /api/DAPPessoaJuridica
Descrição: Endpoint para realizar consultas de Declaração de Aptidão ao Pronaf para pessoas jurídicas.
Nota: É possível gerar comprovantes em PDF utilizando o parâmetro GERARCOMPROVANTE
.
Autenticação
Para acessar esta API, é necessário fornecer um token de autenticação.
Regras de Autenticação:
- O token deve ser enviado como parâmetro na URL da requisição.
- O token é obrigatório para realizar consultas.
Campos da API
Metadados
- Consulta Nome: Nome da consulta realizada.
- Consulta UID: Identificador único da consulta.
- Chave: Chave da consulta.
- Usuário: Nome do usuário que realizou a consulta.
- Mensagem: Mensagem de retorno da consulta.
- IP: Endereço IP de origem da consulta.
- Resultado ID: Identificador do resultado.
- Resultado: Status do resultado.
- API Versão: Versão da API (v3).
- Gerar Comprovante: Indica se foi solicitado comprovante em PDF.
- URL Comprovante: URL para download do comprovante em PDF.
- Assíncrono: Indica se a consulta é assíncrona.
- Data: Data e hora da consulta.
- Tempo Execução: Tempo de execução em milissegundos.
Informações Gerais
- Número DAP: Número da Declaração de Aptidão ao Pronaf.
- Data de Emissão: Data de emissão da DAP.
- Data de Validade: Data de validade da DAP.
- Versão: Versão do documento.
- Município: Localidade vinculada à organização.
- UF: Unidade Federativa correspondente.
Detalhes da Pessoa Jurídica
- CNPJ: Cadastro Nacional de Pessoa Jurídica.
- Razão Social: Nome jurídico da organização.
- Tipo: Classificação da organização (cooperativa, associação, etc.).
- Data de Constituição: Data em que a organização foi fundada.
- Nome do Representante Legal: Nome do representante legal da organização.
- CPF do Representante Legal: Cadastro de Pessoa Física do representante legal.
Emissor
- Emissor: Nome do emissor do documento.
- CNPJ: CNPJ do emissor.
- Nome: Nome completo do emissor.
- CPF: CPF do emissor.
Composição Societária e Associados
- Categoria: Categoria de participantes da organização.
- Quantidade: Número de participantes associados à categoria.
- Participação Relativa: Percentual de participação dos membros na sociedade.
DAPs por Município
- Município: Nome do município relacionado à DAP.
- UF: Unidade Federativa do município.
- Quantidade: Quantidade de DAPs emitidas por município.
Parâmetros
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
CNPJ | string | Sim | CNPJ da pessoa jurídica a ser consultada. Pode ser enviado com ou sem formatação. |
TOKEN | string | Sim | Token de autenticação necessário para a consulta. |
GERARCOMPROVANTE | string | Não | Indica se a consulta deve gerar um comprovante em PDF. |
Exemplo de Requisição
Usando cURL
curl 'https://apiv3.directd.com.br/api/DAPPessoaJuridica?CNPJ=12345678000190&TOKEN=seu_token_aqui&GERARCOMPROVANTE=true'
Respostas
Sucesso (200)
Exemplo de Resposta
{
"metaDados": {
"consultaNome": "string",
"consultaUid": "string",
"chave": "string",
"usuario": "string",
"mensagem": "string",
"ip": "string",
"resultadoId": 0,
"resultado": "string",
"apiVersao": "v3",
"gerarComprovante": false,
"urlComprovante": "string",
"assincrono": true,
"data": "dd/MM/yyyy HH:mm:ss",
"tempoExecucaoMs": 0
},
"retorno": {
"numeroDAP": "string",
"dataEmissao": "string",
"dataValidade": "string",
"versao": "string",
"municipio": "string",
"uf": "string",
"cnpj": "string",
"razaoSocial": "string",
"tipo": "string",
"dataConstituicao": "string",
"nomeRepresentanteLegal": "string",
"cpfRepresentanteLegal": "string",
"emissor": {
"emissor": "string",
"cnpj": "string",
"nome": "string",
"cpf": "string"
},
"composicaoSocietaria": [
{
"categoria": "string",
"quantidade": 0,
"participacaoRelativa": "string"
}
],
"daPsPorMunicipios": [
{
"municipio": "string",
"uf": "string",
"quantidade": 0
}
],
"resultadoAssociados": [
{
"categoria": "string",
"quantidade": 0,
"participacaoRelativa": "string"
}
]
}
}
Erros Comuns
Código | Descrição |
---|---|
200 | Sucesso: retorna um JSON com os dados da consulta. |
201 | Sucesso: a requisição async foi criada com sucesso e está em processamento. |
202 | Em Processamento: a requisição async ainda está em processamento. |
400 | Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos. |
401 | Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso. |
403 | Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível. |
404 | Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado. |
408 | Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido. |
500 | Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte. |
503 | Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte. |
Notas Importantes
- O parâmetro
CNPJ
deve ser fornecido para garantir a precisão da consulta. - É possível gerar comprovantes em PDF, adicionando um custo de 50% ao valor da consulta.
- Em caso de dúvidas ou suporte, entre em contato pelo e-mail suporte@directd.com.br.