guhcostan / brasil-api-promisse

Bliblioteca de integração direta com brazil-api

Brasil API Promise

Bibiloteca de integração com Brasil API

Motivo

Para centralizar e tornar mais facil a utilização da API disponibilizada, foi criada funções especificas abstraindo aplicação de API.

Utilização

Para instalar a lib é nescessario instala-la

npm install brasil-api-promise

Funções

Buscar cep - fetchCep

import BrasilAPI from 'brasil-api-promise'

const cepApi = BrasilAPI.cep()
const cepResult = await cepApi.getCep('05010000')

Sucesso

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

Erro - não encontrado

{
  "message": "Todos os serviços de CEP retornaram erro."
}

Erro - problema de conexão

{
  "code": "EAI_AGAIN",
  "errno": "EAI_AGAIN",
  "message": "request to https://brasilapi.com.br/api/cep/v1/12345678 failed, reason: getaddrinfo EAI_AGAIN brasilapi.com.br",
  "type": "system"
}

Buscar feriados por ano - getFeriadosByAno

import BrasilAPI from 'brasil-api-promise'

const feriados = await BrasilAPI.getFeriadosByAno(1997)

Sucesso

[
   {
      "date":"1997-01-01",
      "name":"Confraternização mundial",
      "type":"national"
   },
   {
      "date":"1997-02-11",
      "name":"Carnaval",
      "type":"national"
   },
   {
      "date":"1997-03-30",
      "name":"Páscoa",
      "type":"national"
   },
   {
      "date":"1997-04-21",
      "name":"Tiradentes",
      "type":"national"
   },
   {
      "date":"1997-05-01",
      "name":"Dia do trabalho",
      "type":"national"
   },
   {
      "date":"1997-05-29",
      "name":"Corpus Christi",
      "type":"national"
   },
   {
      "date":"1997-09-07",
      "name":"Independência do Brasil",
      "type":"national"
   },
   {
      "date":"1997-10-12",
      "name":"Nossa Senhora Aparecida",
      "type":"national"
   },
   {
      "date":"1997-11-02",
      "name":"Finados",
      "type":"national"
   },
   {
      "date":"1997-11-15",
      "name":"Proclamação da República",
      "type":"national"
   },
   {
      "date":"1997-12-25",
      "name":"Natal",
      "type":"national"
   }
]

Erro - não encontrado

{
  "message":"Ano fora do intervalo suportado entre 1900 e 2199.","type":"feriados_range_error","name":"NotFoundError"
}

Erro - problema de conexão

{
  "code": "EAI_AGAIN",
  "errno": "EAI_AGAIN",
  "message": "request to https://brasilapi.com.br/api/feriados/v1/1997 failed, reason: getaddrinfo EAI_AGAIN brasilapi.com.br",
  "type": "system"
}