Trackmob CEPs API

A API de CEPs Trackmob permite buscas na base dos Correios via JSON. É possível fazer buscas a partir de CEPs ou endereços completos.

A base NÂO contém informações de número ou geocoordenadas dos endereços, já que espelha a base dos Correios.

Requisitos do Sistema

Os seguintes pacotes são necessários para rodar localmente a API do Trackmob CEPs:

• git: controle de versão

• postgresql: banco de dados da aplicação

• Webkit: dependência da suíte de testes

• Utilize algum gerenciamento de versão de ruby

  • Versão 2.2.2
  • rbenv
  • rvm

Configurar variáveis de ambiente

• Crie um arquivo .env na raiz do projeto e coloque lá os valores das variáveis de ambiente. Há um arquivo sample com exemplos. necessário para configurar bancos de dados local.

Primeira inicialização

      $ rake db:create db:migrate db:seed
$ rails server
      
    

Comunicação da API

Endereço

Todas as APIs são acessadas via POST e estão no endereço:

      /api/v1/*
    

Acesso

O acesso a API se dá via Header Authorization no Request. Para tal, necessário ter um Token, fornecido pelo sistema. Caso não tenha um, contate o administrador.

APIs

Busca de endereços

Request

A Busca de endereços é feita a partir da API search usando o seguinte Request:

      {
       "query": {
        "street":        "",
        "number":        "",
        "neighbourhood": "",
        "zipcode":       "",
        "state":         "",
        "city":          ""}
        }
      
    

Lembrete

• Nenhum campo é obrigatório;
• Por enquanto, apenas buscas por CEP funcionam, outros campos serão ignorados;

Response

Ao fazer uma busca de endereço usando a API, é devolvido o seguinte JSON:

      {
        "address": {
          "street":        "",
          "number":        "",
          "neighbourhood": "",
          "zipcode":       "",
          "state":         "",
          "city":          ""}
        }
      
    

Lembrete

• Campo number virá sempre vazio;