Skip to content

CnpjApi.md

Latest commit

 

History

History
149 lines (104 loc) · 6.18 KB

CnpjApi.md

File metadata and controls

149 lines (104 loc) · 6.18 KB

ACBrAPI\CnpjApi

Todas as URIs relativas a https://prod.acbr.api.br, exceto se a operação definir outra URI base.

Método Endpoint Descrição
consultarCnpj() GET /cnpj/{Cnpj} Consultar dados do CNPJ
listarCnpj() GET /cnpj Listar estabelecimentos ativos a partir da base de CNPJ

consultarCnpj()

consultarCnpj($cnpj): \ACBrAPI\Model\CnpjEmpresa

Consultar dados do CNPJ

Informações adicionais: - Cota: <a href="/docs/limites#cnpj-consultas">cnpj-consultas - Consumo: 1 unidade por requisição.

Exemplo

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configurar authorização via API key: jwt
$config = ACBrAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ACBrAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configurar access token OAuth2 para autorização: oauth2
$config = ACBrAPI\Configuration::getDefaultConfiguration()->setAccessToken('SEU_ACCESS_TOKEN');


$apiInstance = new ACBrAPI\Api\CnpjApi(
    // Se quiser usar um client http customizado, passe um client que implemente `GuzzleHttp\ClientInterface`.
    // Isso é opcional, `GuzzleHttp\Client` será usado por padrão.
    new GuzzleHttp\Client(),
    $config
);
$cnpj = 'cnpj_example'; // string | CNPJ sem máscara.

try {
    $result = $apiInstance->consultarCnpj($cnpj);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CnpjApi->consultarCnpj: ', $e->getMessage(), PHP_EOL;
}

Parâmetros

Nome Tipo Descrição Notas
cnpj string CNPJ sem máscara.

Tipo do retorno

\ACBrAPI\Model\CnpjEmpresa

Autorização

jwt, oauth2

Headers HTTP da requisição

  • Content-Type: Not defined
  • Accept: application/json

[Voltar ao topo] [Back to API list] [Voltar à lista de DTOs] [Voltar ao README]

listarCnpj()

listarCnpj($cnae_principal, $municipio, $natureza_juridica, $top, $skip, $inlinecount): \ACBrAPI\Model\CnpjListagem

Listar estabelecimentos ativos a partir da base de CNPJ

Retorna uma lista de estabelecimentos de acordo com os critérios de busca utilizados. Somente serão retornados estabelecimentos com situação cadastral "Ativa". Informações adicionais: - Cota: <a href="/docs/limites#cnpj-listagem">cnpj-listagem - Consumo: 1 unidade por estabelecimento listado ou requisição.

Exemplo

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configurar authorização via API key: jwt
$config = ACBrAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ACBrAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configurar access token OAuth2 para autorização: oauth2
$config = ACBrAPI\Configuration::getDefaultConfiguration()->setAccessToken('SEU_ACCESS_TOKEN');


$apiInstance = new ACBrAPI\Api\CnpjApi(
    // Se quiser usar um client http customizado, passe um client que implemente `GuzzleHttp\ClientInterface`.
    // Isso é opcional, `GuzzleHttp\Client` será usado por padrão.
    new GuzzleHttp\Client(),
    $config
);
$cnae_principal = 'cnae_principal_example'; // string | Filtro pelo código CNAE da atividade principal do estabelecimento.  Utilize o valor sem máscara.
$municipio = 'municipio_example'; // string | Filtro pelo código IBGE ou TOM (Tabela de Órgãos e Municípios) do município do estabelecimento.  Utilize o valor sem máscara.
$natureza_juridica = 'natureza_juridica_example'; // string | Filtro pela natureza jurídica do estabelecimento   Utilize o valor de quatro dígitos sem máscara.
$top = 10; // int | Limite no número de objetos a serem retornados pela API, entre 1 e 100.
$skip = 0; // int | Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.
$inlinecount = false; // bool | Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.

try {
    $result = $apiInstance->listarCnpj($cnae_principal, $municipio, $natureza_juridica, $top, $skip, $inlinecount);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CnpjApi->listarCnpj: ', $e->getMessage(), PHP_EOL;
}

Parâmetros

Nome Tipo Descrição Notas
cnae_principal string Filtro pelo código CNAE da atividade principal do estabelecimento. Utilize o valor sem máscara.
municipio string Filtro pelo código IBGE ou TOM (Tabela de Órgãos e Municípios) do município do estabelecimento. Utilize o valor sem máscara.
natureza_juridica string Filtro pela natureza jurídica do estabelecimento Utilize o valor de quatro dígitos sem máscara.
top int Limite no número de objetos a serem retornados pela API, entre 1 e 100. [optional] [default to 10]
skip int Quantidade de objetos que serão ignorados antes da lista começar a ser retornada. [optional] [default to 0]
inlinecount bool Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação. [optional] [default to false]

Tipo do retorno

\ACBrAPI\Model\CnpjListagem

Autorização

jwt, oauth2

Headers HTTP da requisição

  • Content-Type: Not defined
  • Accept: application/json

[Voltar ao topo] [Back to API list] [Voltar à lista de DTOs] [Voltar ao README]