-
Notifications
You must be signed in to change notification settings - Fork 8
Home
API de dados do Mapa das Organizações da Sociedade Civil
A API Mapa OSC fornece um acesso programático para a leitura e a escrita de dados do Mapa das Organizações da Sociedade Civil do Ipea. A API está disponível para ser utilizada somente dentro da rede interna do Ipea no endereço mapaosc.ipea.gov.br:8383/api por meio do protocolo HTTPS.
A utilização da API pode ser realizada através de qualquer web browser, assim como por qualquer outra ferramenta que faça a comunicação com o protocolo HTTP. Diversos serviços estão disponíveis para serem utilizados diretamente da URL específica do serviço. Outros serviços precisam que dados sejam passados no cabeçalho ou no corpo da requisição, necessitando assim de uma preparação mais detalhista.
O acesso total da API ainda condicionada a restrições de acesso impostas aos serviços. Enquanto que alguns estão disponíveis para serem utilizados por qualquer um com acesso a rede interna do Ipea, outros estão disponíveis para serem utilizados somente quando um token de acesso, gerado anteriormente pela própria API, é enviado junto a requisição do serviço.
Nas descrições dos serviços apresentadas mais à frente, é apresentado as necessidades e as restrições de cada um deles.
O endereço base para o acesso da API Mapa OSC é a seguinte base: https://www.mapaosc.ipea.gov.br:8383/api
Os serviços disponíveis na API são acessíveis por meio deste endereço juntamente com a rota específica do serviço – disposta após este endereço base – enviados via o método do HTTP especificado para o serviço.
A documentação está dividida nas seguintes seções: