Documentação de Endpoints para acesso à plataforma de AppCivicos do TCU.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
logos
EscolasAPI.md
EstabelecimentosAPI.md
GetStarted.md
GuiaMetamodelo.md
MetamodeloAPI.md
README.md

README.md

AppCivico / Nuvem Cívica

Documentação de Endpoints para acesso à plataforma de AppCivicos do TCU.

Dados Abertos

Visando facilitar o acesso à dados abertos do governo para a comunidade de desenvolvedores o Tribunal de Contas da União criou a plataforma AppCívico, que fornece através de uma API de serviços REST informações abertas. Exemplo:

O objetivo é fazer com que mais desenvolvedores, interessados em desenvolver aplicações cívico sociais possam ter acesso de maneira fácil à dados abertos, gerando cada vez mais aplicações de utilidade pública, que poderão prover tranparência das informações e de certa forma ajudar a população.

Metamodelo

Desenvolvedores de aplicativos móveis engajados em causas de cunho cívico ou social, interessados em se lançar em projetos de utilidade pública, muitas vezes esbarram em dificuldades que complicam ou até inviabilizam seus projetos. Entre os problemas mais frequentes estão o custo de serviços de cloud e a dificuldade de se desenvolver um serviço de backend, em geral webservices REST, para armazenamento de dados da sua aplicação. O desenvolvedor que se interessa por aplicações de cunho cívico social ou de utilidade pública costuma não visar lucro, trabalha individualmente ou em pequenos grupos, e por isso tem dificuldade em arcar com os custos de hospedagem de dados ou de um serviço de cloud. Além desse problema com os custos, existe a esforço de desenvolvimento desses serviços. Contruir um serviço em cloud para servir de backend para uma aplicação é uma tarefa a mais que o desenvolvedor tem no processo de contrução da aplicação e que muitas vezes consome até mais tempo do que o desenvolvimento da própria aplicação.

Pensando nisso a plataforma AppCívico, também chamada de Nuvem Cívica, disponibiliza um conjunto de serviços concebidos como uma abstração de um metamodelo genérico, que se propõe a prover serviços básicos para qualquer aplicativo móvel típico. O metamodelo provê serviços como cadastro e armazenamento de usuários, criação de perfis específicos para determinado aplicativo , login com senha ou com redes sociais Facebook, Twitter, Instagram e GooglePlus. Além de dar suporte à dados de usuários o metamodelo também proporciona a criação de grupos de usuário relacionados a um aplicativo, provê também suporte à notificações para aplicativos móveis. Para armazenamento de dados bastante genéricos é dado ao desenvolvedor o objeto de Postagem onde criada uma postagem, pode - se associar vários conteúdos a mesma seja ele objetos da aplicação ou arquivos binários como por exemplo fotos ou vídeos. Os conteúdos que são objetos objetos são salvos como no formato JSON, fazendo com que ele seja dinâmico e genérico podendo armazenar qualquer objeto. Podendo posteriormente alterar, excluir e fazer buscas nos mesmos. A seguir iremos abordar cada endpoint do metamodelo especificando como funciona, como cada entidade se relaciona e como usa - lo na sua aplição. Umas das grandes utilidades desse metamodelo, além de facilitar o trabalho do desenvolvedor é contribuir a geração de informação aberta e dados de utilidade pública que podem ajudar a população e contribuir para que os dados abertos se tornem mais precisos. Um exemplo dessa geração de informação, são aplicativos que já usam a base de estabelecimentos de saúde e de escolas, e que por meio de uma mecânica colaborativa o usuário pode dar feedback na localização do local, dando assim sugestões de onde seria a localização correta, o que ajuda a tornar a qualidade da informação melhor o que faz com que os aplicativos construidos a partir dessa informação, consigam ser mais efetivos no dia-a-dia da população que utiliza os mesmo.

API Reference

Links para Documentação das API

Guia rápido para uso das API's abertas

Guia de uso do metamodelo da Nuvem Cívica

API de Estabelecimentos de Saúde

API de Escolas

API do Metamodelo

API de Centros de Referência de Assistência Social (CRAS)

API de Centros de Referência Especializado de Assistência Social - Creas

API de Postos do Site Nacional de Empregos

Links e informações úteis