Ipage Software

API CEP

Como funciona um API?

API é uma solução utilizada na integração de sistemas e na comunicação entre aplicações diferentes. Com esta tecnologia é possível que novas aplicações possam interagir com aquelas que já existem e que sistemas desenvolvidos em plataformas diferentes sejam compatíveis.

A que se destina este API?

Este API tem por finalidade consultar Códigos de endereçamento Postal (CEP) de todo o Brasil de forma simples e descomplicada.
As informações retornadas após a consulta a API possui diversos formatos, são eles: XML, JSON, JavaScript, formato texto PIPED, formato texto Querty.

Nossa API simplifica o preenchimento de cadastro. Basta informar o código do endereçamento postal (CEP) e a API retornará os seguintes dados:
bairro, cep, cidade, complemento, ddd, distância da capital, faixa de cep, gentílico, gia, ibge, latitude, logradouro, logradouro2, longitude, mesorregião, microrregião, região, tempo percurso veículo, tipo de logradouro, uf, unidade.

Caso a consulta seja realizada pelo CNPJ, além dos dados do endereço, serão retornados os dados referentes a empresa, vejamos abaixos os dados listados:
razão social, nome fantasia, data de abertura da empresa, tipo de empresa, data da situação, atividade principal, cnae, capital social, natureza jurídica, bairro, cep, cidade, complemento, ddd, distância da capital, faixa de cep, gentílico, gia, ibge, latitude, logradouro, logradouro2, longitude, mesorregião, microrregião, região, tempo percurso veículo, tipo de logradouro, uf, unidade.

Definição dos parâmetros.

O CEP informado deve conter apenas números com até 08 (oito caracateres), em caso de valores inválidos passados a API o mesmo realizará automaticamente um filtro, deixando passar apenas números. Se mesmo assim o valor do CEP informado não satisfazer o critério uma mensagem de erro será reportada. A mesma regra aplica-se ao CNPJ.

O formato a ser retornado pela consulta deve ser passado na URL junto com o CEP e deve ser compatível com o esperado pela API.
Os valores válidos são: XML, JSON, JavaScript, formato texto PIPED, formato texto Querty.

Chave de acesso.

A chave de acesso ao Web Service é obrigatória e deve ser passada na URL junto com o código de barras, e deve ser compatível com o esperado pelo Web Service. Caso não possua uma chave de acesso, solicite no formulário abaixo clicando aqui.

Pesquisa por CEP

Exemplo de retorno a chamada a api com a pesquisa por CEP e retorno em JSON. (Ver exemplo)

$curl = curl_init();
curl_setopt_array($curl, array(
	CURLOPT_URL => "https://ipage_cep.p.rapidapi.com/ws/cep/v1/application/views/cep/?cep=50870050
  &key=57a97589b6be11e9a80952540046af69",
	CURLOPT_RETURNTRANSFER => true,
	CURLOPT_ENCODING => "",
	CURLOPT_MAXREDIRS => 10,
	CURLOPT_TIMEOUT => 30,
	CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
	CURLOPT_CUSTOMREQUEST => "GET",
	CURLOPT_HTTPHEADER => array(
		"x-rapidapi-host: ipage_cep.p.rapidapi.com",
		"x-rapidapi-key: SIGN-UP-FOR-KEY" // É necessario adquirir a chave de acesso
	),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
	echo "cURL Error #:" . $err;
} else {
	echo $response;
}

var settings = {
 "async": true,
 "crossDomain": true,
 "url": "https://ipage_cep.p.rapidapi.com/ws/cep/v1/application/views/cep/?cep=50870050
 &key=57a97589b6be11e9a80952540046af69",
 "method": "GET",
 "headers": {
  "x-rapidapi-host": "ipage_cep.p.rapidapi.com",
	"x-rapidapi-key": "SIGN-UP-FOR-KEY" // É necessario adquirir a chave de acesso
 }
}

$.ajax(settings).done(function (response) {
 console.log(response);
});

{
    "bairro": "AREIAS"
    "cep": "50870-050"
    "cidade": "RECIFE"
    "complemento": ""
    "ddd": "81"
    "distancia_da_capital": "1 m"
    "faixa_de_cep": "50000-001 A 52999-999"
    "gentilico": "RECIFENSE"
    "gia": ""
    "ibge": "2611606"
    "latitude": "-8.0935939"
    "logradouro": "FREI MANUEL CALADO"
    "logradouro2": "RUA FREI MANUEL CALADO"
    "longitude": "-34.9317320"
    "mesorregiao": "METROPOLITANA DE RECIFE"
    "microrregiao": "RECIFE"
    "regiao": "NORDESTE"
    "tempo_percurso_veiculo": "1 min"
    "tp_logradouro": "RUA"
    "uf": "PE"
    "unidade": ""
}

C
C#
GO
JAVA
Java Script
Node.js
Objective-C
VB.Net
VB6

PHP
JQuery
OCaml
PowerShell
Python
Ruby
Shell
Swift
RapidQL

XML
Piped
javascript
Querty

E se o usuário não souber o CEP?

Em casos em que o usuário desconheçe o CEP do endereço que ele procura, o API possui um método que pode consultar os dados por endereço. basta informar a UF, o Município e por fim o Logradouro.
As informações retornadas após a consulta a API possui diversos formatos, são eles: XML, JSON, JavaScript
Não é necessário inserir o nome do município por completo e a mesma regra se aplica ao informar o logradouro

Atenção! Substitua o espaço em branco entre as palavras pelo caracter +.
Exemplo: São Paulo, ficaria Sao-Paulo. Não será permitido caracetres especiais ou acentuados.
O formato texto PIPED e o formato texto Querty não são suportados!

Pesquisa por Endereço

Exemplo de retorno a chamada a api com a pesquisa por Endereço e retorno em JSON.

$curl = curl_init();
curl_setopt_array($curl, array(
 CURLOPT_URL => "https://ipage_cep.p.rapidapi.com/ws/cep/v1/application/views/endereco/?uf=rj
 &cidade=rio&key=57a97589b6be11e9a80952540046af69&logradouro=rua%20da%20v",
 CURLOPT_RETURNTRANSFER => true,
 CURLOPT_ENCODING => "",
 CURLOPT_MAXREDIRS => 10,
 CURLOPT_TIMEOUT => 30,
 CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
 CURLOPT_CUSTOMREQUEST => "GET",
 CURLOPT_HTTPHEADER => array(
	"x-rapidapi-host: ipage_cep.p.rapidapi.com",
	"x-rapidapi-key: SIGN-UP-FOR-KEY" // É necessario adquirir a chave de acesso
 ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
	echo "cURL Error #:" . $err;
} else {
	echo $response;
}

var settings = {
 "async": true,
 "crossDomain": true,
 "url": "https://ipage_cep.p.rapidapi.com/ws/cep/v1/application/views/endereco/?uf=rj
 &cidade=rio&key=57a97589b6be11e9a80952540046af69&logradouro=rua%20da%20v",
 "method": "GET",
 "headers": {
	"x-rapidapi-host": "ipage_cep.p.rapidapi.com",
	"x-rapidapi-key": "SIGN-UP-FOR-KEY" // É necessario adquirir a chave de acesso
 }
}

$.ajax(settings).done(function (response) {
 console.log(response);
});

{
   "enderecos": {
     "endereco_1": {
     "bairro": "REALENGO"
     "cep": "21765-760"
     "cidade": "RIO DE JANEIRO"
     "complemento": ""
     "ddd": "21"
     "distancia_da_capital": "1 m"
     "faixa_de_cep": "20000-001 A 23799-999"
     "gentilico": "CARIOCA"
     "gia": ""
     "ibge": "3304557"
     "latitude": "-22.9178476"
     "logradouro": "DA VERDADE"
     "logradouro2": "RUA DA VERDADE"
     "longitude": "-43.6934244"
     "mesorregiao": "METROPOLITANA DO RIO DE JANEIRO"
     "microrregiao": "RIO DE JANEIRO"
     "regiao": "SUDESTE"
     "tempo_percurso_veiculo": "1 min"
     "tp_logradouro": "RUA"
     "uf": "RJ"
     "unidade": ""
   }
   "endereco_2": {
     "bairro": "SANTA CRUZ"
     "cep": "23555-135"
     "cidade": "RIO DE JANEIRO"
     "complemento": ""
     "ddd": "21"
     "distancia_da_capital": "1 m"
     "faixa_de_cep": "20000-001 A 23799-999"
     "gentilico": "CARIOCA"
     "gia": ""
     "ibge": "3304557"
     "latitude": "-22.9178476"
     "logradouro": "DA VERDADE"
     "logradouro2": "RUA DA VERDADE"
     "longitude": "-43.6934244"
     "mesorregiao": "METROPOLITANA DO RIO DE JANEIRO"
     "microrregiao": "RIO DE JANEIRO"
     "regiao": "SUDESTE"
     "tempo_percurso_veiculo": "1 min"
     "tp_logradouro": "RUA"
     "uf": "RJ"
     "unidade": ""
  }
 }
}

C
C#
GO
JAVA
Java Script
Node.js
Objective-C
VB.Net
VB6

PHP
JQuery
OCaml
PowerShell
Python
Ruby
Shell
Swift
RapidQL

XML
Piped
javascript
Querty

Pesquisa por CNPJ

Exemplo de retorno a chamada a api com a pesquisa por CNPJ e retorno em JSON. (Ver exemplo)

$curl = curl_init();
curl_setopt_array($curl, array(
 CURLOPT_URL => "https://ipage_cep.p.rapidapi.com/ws/cep/v1/application/views/cnpj/?key=57a97589b6be11e9a80952540046af69
 &cnpj=27.865.757/0001-02",
 CURLOPT_RETURNTRANSFER => true,
 CURLOPT_ENCODING => "",
 CURLOPT_MAXREDIRS => 10,
 CURLOPT_TIMEOUT => 30,
 CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
 CURLOPT_CUSTOMREQUEST => "GET",
 CURLOPT_HTTPHEADER => array(
	"x-rapidapi-host: ipage_cep.p.rapidapi.com",
	"x-rapidapi-key: "SIGN-UP-FOR-KEY" // É necessario adquirir a chave de acesso
 ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
	echo "cURL Error #:" . $err;
} else {
	echo $response;
}

var settings = {
	"async": true,
	"crossDomain": true,
	"url": "https://ipage_cep.p.rapidapi.com/ws/cep/v1/application/views/cnpj/?key=57a97589b6be11e9a80952540046af69
  &cnpj=27.865.757/0001-02",
	"method": "GET",
	"headers": {
		"x-rapidapi-host": "ipage_cep.p.rapidapi.com",
		"x-rapidapi-key": "SIGN-UP-FOR-KEY" // É necessario adquirir a chave de acesso
	}
}

$.ajax(settings).done(function (response) {
	console.log(response);
});

{
    "abertura": "31/01/1986"
    "atividade_principal": "ATIVIDADES DE TELEVISAO ABERTA"
    "atividades": {
        "secundaria_1": {
            "descricao": "REPRODUCAO DE VIDEO EM QUALQUER SUPORTE"
            "cnae": "18.30-0-02"
        }
        "secundaria_2": {
            "descricao": "PORTAIS, PROVEDORES DE CONTEUDO E OUTROS SERVICOS DE INFORMACAO NA INTERNET"
            "cnae": "63.19-4-00"
        }
        "secundaria_3": {
            "descricao": "AGENCIAMENTO DE ESPACOS PARA PUBLICIDADE, EXCETO EM VEICULOS DE COMUNICACAO"
            "cnae": "73.12-2-00"
        }
        "secundaria_4": {
            "descricao": "PROGRAMADORAS"
            "cnae": "60.22-5-01"
        }
    }
    "bairro": "JARDIM BOTANICO"
    "capital_social": "6453568523.86"
    "cep": "22460-901"
    "cidade": "RIO DE JANEIRO"
    "cnae": "60.21-7-00"
    "cnpj": "27.865.757/0001-02"
    "complemento": ""
    "data_situacao": "03/11/2005"
    "data_situacao_especial": ""
    "ddd": "21"
    "distancia_da_capital": "1 m"
    "efr": ""
    "email": ""
    "faixa_de_cep": "20000-001 A 23799-999"
    "fantasia": "GCP,TV GLOBO, REDE GLOBO, GLOBO.COM, SOM LIVRE"
    "gentilico": "CARIOCA"
    "gia": ""
    "ibge": "3304557"
    "latitude": "-22.9649139"
    "logradouro": "LOPES QUINTAS, 303"
    "logradouro2": "RUA LOPES QUINTAS, 303"
    "longitude": "-43.2198286"
    "mesorregiao": "METROPOLITANA DO RIO DE JANEIRO"
    "microrregiao": "RIO DE JANEIRO"
    "motivo_situacao": ""
    "municipio": "RIO DE JANEIRO"
    "natureza_juridica": "205-4 - SOCIEDADE ANONIMA FECHADA"
    "num": "303"
    "porte": "DEMAIS"
    "razao_social": "GLOBO COMUNICACAO E PARTICIPACOES S/A"
    "regiao": "SUDESTE"
    "situacao": "ATIVA"
    "situacao_especial": ""
    "status": "OK"
    "telefone": {
        "fone_1": "(21) 2155-4551"
        "fone_2": "(21) 2155-4552"
    }
    "tempo_percurso_veiculo": "1 min"
    "tipo": "MATRIZ"
    "tp_logradouro": "RUA"
    "uf": "RJ"
    "ultima_atualizacao": "28/08/2019 14:08:27"
    "unidade": ""
}

C
C#
GO
JAVA
Java Script
Node.js
Objective-C
VB.Net

VB6
OCaml
PowerShell
Python
Ruby
Shell
Swift
RapidQL

XML
Piped
javascript
Querty

GitHub

Baixe os exemplos em:

https://github.com/ipagesoftware

Nossos planos

https://rapidapi.com/diogenes/api/ipage_cep/pricing

Nota: Todo o tramite ao solicitar a aquisição dos serviços da api ocorrerá através do maior mercado de APIs do mundo o RapidAPI. Com aproximadamente 1.000.000 desenvolvedores, bilhões de chamadas as APIs ao mês, disponível em mais de 175 país com suporte em todo mundo. O RapidAPI permite uma maior facilidade e segurança aos pagamentos e a garantia que você pague apenas pelos planos que usa.

Caso não se sinta confortável em utilizar os serviços da RapidAPI, favor entrar em contato através do email: diogenesdias@hotmail.com para informamos como proceder com as demais formas de pagamentos

Perguntas frequentes

Minhas informações de pagamentos estão seguras?

Os cartões de crédito são processados por meio de um parceiro bancário compatível com PCI (Security Standards Council) ou Conselho de Padrões de Segurança.

E se exceder o limite do meu plano?

Dependendo da especificação do seu plano, você será cobrado em excesso das consultas ou será bloqueado temporariamente.

Quando serei cobrado?

Cobramos em seu cartão de crédito após a assinatura do plano de uma API e no próximo intervalo recorrente.

Como são tratados os reembolsos?

Para solicitações de reembolso, entre em contato conosco em support@rapidapi.com

Não tenho cartão de crédito, posso pagar de outra maneira?

Sim, claro! O pagamento poderá ser realizado através de depósito bancário em conta corrente.

Dados da Conta Corrente:

BANCO DO BRASIL
AG. 1814-7
CONTA CORRENTE: 18135-8
CPF.: 521.384.454-53
BENEFICIÁRIO: DIOGENES DIAS DE SOUZA JÚNIOR

Através do Paypal (solicitar link de pagamento)

Através do PagSeguro (solicitar link de pagamento)

Ainda tem dúvidas?

Em caso de dúvidas favor entrar em contato através dos nossos canais de atendimento listados abaixo:

Cadastro

Solicite a chave de acesso ao Web Service CEP.

Para que o nosso Web Service funcione adequadamente, será necessário soliictar uma chave de acesso de uso orbigatório.

Atenção! Informe um email válido, é através dele que sua chave de acesso ao Web Service será disponibilizada.
Caso não receba a confirmação da sua solicitação em sua caixa de entrada, verifique seu mecanismo de SPAM.
Evite gerar várias solicitações antes de confirmar a solicitação anterior, o seu IP ou email informado poderá ser bloqueado.

Atenção!
Ao preencher esse formulário, seu nome e email farão parte de nosso cadastro tendo por único objetivo apenas vincular a chave da API gerada. Garantimos que os seus dados não serão utilizados para nenhuma outra finalidade.

Os dados são administrados de acordo com as regras da LGPD (Lei Geral de Proteção de Dados) .

* Campos obrigatórios.

Nome: *

Email: *

Como Conheceu este Produto? *

Código Acesso: *