« HE:labs

Brazil Postal Code API - Brapi

Postado por Ali Ismayilov em 12/05/2014

Today we announce our new Heroku addon - Brapi. Brapi will provide programmatic access to postal code, city, POI, address information about Brazil. It is built for developers, like us.


Currently, Brapi provides following endpoints:

  • PostalCode GET by postal code numbers
  • City GET by IBGE code
  • PostalCode POST update/create

Response you get is a JSON object:

 1 {
 2   "neighborhood": "Centro",
 3   "street_name": "Presidente Vargas",
 4   "street_type": "Avenida",
 5   "formatted_postal_code": "20071-905",
 6   "postal_code_numbers": "20071905",
 7   "complement": "- de 585 a 1261 - lado ímpar",
 8   "location": null,
 9   "city": {
10     "name": "Rio de Janeiro",
11     "ibge_code": "3304557",
12     "state": "RJ",
13     "state_ibge_code": "33"
14   }
15 }

We, at HE:labs try to make our customers lives easy. We try to solve their problems with simpler solutions. We believe that keeping things simple makes us more productive. Also we contribute for open source to make developers lives easy too.

Here we present alpha access to our brand new API - Brapi. Brapi will allow developers easily provide access to Brazilian postal codes and cities. By programmatically accessing this data developers can build better UX for their customers with less effort.

To keep things simple, we will provide Brapi service through Heroku Addons. The service was already reviewed by Heroku team, and ready for use. But before going public, we'd like to give exclusive access to our readers. This way we want to receive early feedback and meet the most desired features.

If your application is already on Heroku (being on alpha you need to be invited also), all you need to do is to run:

1 $ heroku addons:add brapi
2 -----> Adding brapi to sharp-mountain-4005... done, v18 (free)

This will set BRAPI_TOKEN variable on your app which you can use to make authenticated requests to Brapi.

To get an early access write us on tech@helabs.com.br.

If you are interested in integrating the API in your software, keep reading us and we'll tell you more about Brapi's Ruby and PHP clients on our next blog posts :wink:.


Sabia que nosso blog agora está no Medium? Confira Aqui!