transparencia

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

Entrada	Descrição
Candidatos	Ops sobre candidatos
Partidos	Ops sobre partidos políticos brasileiros
Estados	Ops sobre estados da federação
Cargos	Ops sobre cargos eletivos em 2014
Excelencias	Ops sobre parlamentares

Códigos de erro

Code	Text	Description
200	OK	Sucesso!
400	Bad Request	A requisição possui parametro(s) inválido(s)
401	Unauthorized	O token de acesso não foi informado ou não possui acesso as APIs.
404	Not Found	O recurso informado no request não foi encontrado.
413	Request is to Large	A requisição está ultrapassando o limite permitido para o perfil do seu token de acesso.
422	Unprocessable Entity	A requisição possui erros de negócio.
429	Too Many Requests	O consumidor estourou o limite de requisições por tempo.
500	Internal Server Error	Erro não esperado, algo está quebrado na API.

Browser Compatibility

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