Brasil API

Vamos transformar o Brasil em uma API?

Motivo

Acesso programático de informações é algo fundamental na comunicação entre sistemas mas, para nossa surpresa, uma informação tão útil e pública quanto um CEP não consegue ser acessada diretamente por um navegador por conta da API dos Correios não possuir CORS habilitado.

Dado a isso, este projeto experimental tem como objetivo centralizar e disponibilizar endpoints modernos com baixíssima latência utilizando tecnologias como Vercel Smart CDN responsável por fazer o cache das informações em atualmente 23 regiões distribuídas ao longo do mundo (incluindo Brasil). Então não importa o quão devagar for a fonte dos dados, nós queremos disponibilizá-la da forma mais rápida e moderna possível.

Como contribuir

Através do Next.js, um framework utilizado por empresas como Marvel, Twitch, Nike, Hulu, TypeForm, Nubank, Ferrari, TikTok, Square Enix, entre outras, estamos construindo a página de apresentação do projeto e, por ser um framework híbrido, ele possibilita a construção e deploy de APIs com o mínimo de configuração possível em uma infraestrutura autoescalável da Vercel, a mesma que conta com recursos sensacionais como a Vercel Smart CDN.

Caso você esteja lendo esta versão de README, você está pegando o projeto num estágio extremamente inicial, porém empolgante, pois há várias coisas a serem definidas. Então caso queira contribuir, utilize as issues para entender quais pontos ainda não foram resolvidos, conversar conosco e contribuir tanto com idéias técnicas, quanto de quais APIs podem ser criadas.

Veja mais detalhes sobre Como contribuir no arquivo CONTRIBUTING.md

Endpoints

O primeiro endpoint a ser implementado precisava ser o que estava nos dando a maior dor de cabeça: busca de um endereço através do CEP. É um endpoint extremamente simples de implementar, mas vários detalhes ainda não foram resolvidos, como garantir seu comportamento através de testes E2E utilizando a Preview URL que a Vercel retorna a cada Pull Request. Depois de consolidarmos as melhores práticas para esse endpoint, poderemos replicar para todos os outros que irão vir.

CEP

Busca por CEP com múltiplos providers de fallback.

GET https://brasilapi.com.br/api/cep/v1/[cep]

Consulta com sucesso

// GET https://brasilapi.com.br/api/cep/v1/05010000

{
  "cep": "05010000",
  "state": "SP",
  "city": "São Paulo",
  "neighborhood": "Perdizes",
  "street": "Rua Caiubi"
}

Consulta com erro

// GET https://brasilapi.com.br/api/cep/v1/00000000

{
  "name": "CepPromiseError",
  "message": "Todos os serviços de CEP retornaram erro.",
  "type": "service_error",
  "errors": [
    {
      "name": "ServiceError",
      "message": "CEP INVÁLIDO",
      "service": "correios"
    },
    {
      "name": "ServiceError",
      "message": "CEP não encontrado na base do ViaCEP.",
      "service": "viacep"
    }
  ]
}

Banks

Busca por dados dos bancos brasileiros direto na base de dados do Bacen.

GET https://brasilapi.com.br/api/banks/v1/[code]

Consulta com sucesso

// GET https://brasilapi.com.br/api/banks/v1/260

{
  "ispb": "18236120",
  "name": "NU PAGAMENTOS S.A.",
  "code": 260,
  "fullName": "Nu Pagamentos S.A."
}

Consulta com código incorreto

// GET https://brasilapi.com.br/api/banks/v1/1111111

{
  "message": "Código bancário não encontrado",
  "type": "BANK_CODE_NOT_FOUND"
}

GET https://brasilapi.com.br/api/banks/v1

Consulta com sucesso

// GET https://brasilapi.com.br/api/banks/v1

[
  {
    "ispb": "18236120",
    "name": "NU PAGAMENTOS S.A.",
    "code": 260,
    "fullName": "Nu Pagamentos S.A."
  },
  ...
]

DDD

Busca as cidades brasileiras referente a um DDD.

GET https://brasilapi.com.br/api/ddd/v1/11[code]

Consulta com sucesso

// GET https://brasilapi.com.br/api/ddd/v1/11

{
  "state": "SP",
  "cities": [
    "EMBU",
    "VÁRZEA PAULISTA",
    "VARGEM GRANDE PAULISTA",
    "VARGEM",
    "TUIUTI",
    "TABOÃO DA SERRA",
    "SUZANO",
    "SÃO ROQUE",
    "SÃO PAULO",
    ...
  ]
}

Consulta com ddd incorreto

// GET https://brasilapi.com.br/api/ddd/v1/01

{
  "name": "ddd_error",
  "message": "DDD não encontrado",
  "type": "DDD_NOT_FOUND"
}

Consulta com erro

// GET https://brasilapi.com.br/api/ddd/v1/17

{
  "name": "ddd_error",
  "message": "Todos os serviços de DDD retornaram erro.",
  "type": "service_error"
}

Termos de Uso

O BrasilAPI é uma iniciativa feita de brasileiros para brasileiros, por favor, não abuse deste serviço. Estamos em beta e ainda elaborando os Termos de Uso, mas por enquanto por favor não utilize formas automatizadas para fazer "crawling" dos dados da API. Um exemplo prático disto é um dos maiores provedores de telefonia do Brasil estar revalidando, neste exato momento, todos os Ceps (de 00000000 até 99999999) e estourando em 5 vezes o limite atual da nossa conta no servidor. O volume de consulta dever ter a natureza de uma pessoa real requisitando um determinado dado. E para consultas com um alto volume automatizado, iremos mais para frente fornecer alguma solução, como por exemplo, conseguir fazer o download de toda a base de Ceps em uma única request.

Contribuidores

@kevenleone	@OtavioCapila	@rafamancan	@lucas-eduardo	@eliseumds	@evertoncastro
@mukaschultze	@paulogdm	@mathleite	@WeslleyNasRocha	@paulo-santana	@RaphaelOliveiraMoura
@guiaramos	@marceloF5	@tupizz	@FlavioAndre	@matheusvellone	@danielramosbh74
@juniorpb	@CarlosZiegler	@otaciliolacerda	@RodriAndreotti	@lucasbastianik	@paulosales
@eklauberg

Autores

@filipedeschamps	@lucianopf