Visão Geral | Desenvolvedores Transparência Brasil
Todos os serviços disponibilizados através da API utilizam a tecnologia REST (Representational State Transfer), uma arquitetura para a disponibilização de recursos através de sistemas distribuídos, popularmente utilizado sobre HTTP. Abaixo podemos verificar exemplos de como os serviços são formados:
A partir do Recurso Raiz, podemos acessar as principais operações do serviço. Como a API da Transparência Brasil disponibiliza apenas dados para consulta, é utilizado somente o método HTTP GET
Exemplo de response do recurso /estados:
"EstadoId": "1",
"EstadoId": "2",
https://api.transparencia.org.br/api/v1/candidatos?_offset=0&_limit=100
Página Autenticação:
Todas as chamadas deverão conter, além dos campos da requisição, um campo no cabeçalho para a identificação de segurança. O nome desse campo é:
Application Token (ou App-Token): Token que identifica a Aplicação que está efetuando a chamada aos recursos disponibilizados através da API.
Uma vez que você tenha se inscrito no portal, basta clicar no link "APPS" no cabeçalho.
Daí, basta registrar um novo App conforme imagem abaixo:
Depois de preencher os dados, você obterá uma tela como a abaixo. Basta copiar o App-Token e usá-lo em todas as chamadas das APIs:
Para testar se seu App-Token está válido e funcional, basta acessar o API Browser no menu Documentação. Escolher algum recursos e fazer o "Try it out!" conforme a imagem abaixo: