Como funciona

---

• Passo a passo
• Layouts
• FAQ

---

Passo a passo

Para utilizar a API ceplivre, basta seguir o passo a passo indicado abaixo:

Passo 1: assinatura

Escolha um dos planos disponíveis para assinatura. Preencha o formulário com os dados cadastrais, seja para pessoa física ou pessoa jurídica.

Passo 2: confirmação e pagamento da assinatura

Ao concluir o preenchimento do formulário de assinatura, você receberá um e-mail com instruções para confirmar seus dados. Ao confirmá-los, você receberá um e-mail com o boleto para pagamento.

O acesso à API ceplivre será liberado em até 48 horas após o seu pagamento.

Passo 3: utilização do ceplivre

Para utilizar a API ceplivre, você deverá desenvolver uma função, classe ou rotina que faça acessos via HTTP ao nosso servidor. As URLs de pesquisa seguem um formato regular definido da seguinte maneira:

https://ceplivre.com.br/consultar/$tipo/$key/$busca/$formato

Onde:

• $tipo é o tipo de busca, por CEP (cep) ou por endereço (logradouro);
• $key é a chave de autenticação enviada por e-mail na confirmação da assinatura;
• $busca é o termo de busca. Se for um CEP, o código (01311-000). Se for um endereço, parte do nome (Paulista);
• $formato é o formato do resultado da busca que pode ser XML (xml), CSV (csv) ou JSON (json).

Exemplos de busca

Para todos os exemplos de busca abaixo, utilizaremos a chave de autenticação fictícia 123.

• Busca pelo CEP 01311-000 em formato JSON:
  https://ceplivre.com.br/consultar/cep/123/01311-000/json
• Busca pelo endereço Paulista em formato XML:
  https://ceplivre.com.br/consultar/logradouro/123/paulista/xml