0.0.2 • Published 6 years ago

transparencia v0.0.2

Weekly downloads
2
License
MIT
Repository
github
Last release
6 years ago

transparência.js

Um wrapper javascript sobre a API do transparencia.gov.br

HEAVY DEV

Install

$ npm install --save transparencia

ou

$ bower install --save transparencia

Uso

Seu uso é feito a partir do conceito de funções de entrada e funções complementares.

As funções de entrada são as bases dos endpoints: candidatos, partidos, estados, cargos, excelencias. As funções de saída são aquelas que complementam um endpoint: bens, doadores, candidaturas, estatisticas.

Preparada a chamada, basta então executar a função get que retorna então uma promessa:

var transparencia = new Transparencia('TOKEN');

transparencia
	.candidatos({estado: 'SP', cargo: 3})
	.get()
	.then(function (results) {
	  console.log(results);
	}, function (err) {
	  console.error(err);
	});

transparencia
	.candidatos('ID')
	.doadores({anoEleitoral: '2010'})
	.get()
	.then(function (results) {
	  console.log(results);
	}, function (err) {
	  console.error(err);
	});

API

EntradaDescrição
CandidatosOps sobre candidatos
PartidosOps sobre partidos políticos brasileiros
EstadosOps sobre estados da federação
CargosOps sobre cargos eletivos em 2014
ExcelenciasOps sobre parlamentares

Códigos de erro

CodeTextDescription
200OKSucesso!
400Bad RequestA requisição possui parametro(s) inválido(s)
401UnauthorizedO token de acesso não foi informado ou não possui acesso as APIs.
404Not FoundO recurso informado no request não foi encontrado.
413Request is to LargeA requisição está ultrapassando o limite permitido para o perfil do seu token de acesso.
422Unprocessable EntityA requisição possui erros de negócio.
429Too Many RequestsO consumidor estourou o limite de requisições por tempo.
500Internal Server ErrorErro não esperado, algo está quebrado na API.

Browser Compatibility

Using testling-ci is a must. It is certainly in the road map :neckbeard:

0.0.2

6 years ago

0.0.1

6 years ago