Professional Documents
Culture Documents
e-PING
Padres de Interoperabilidade
de Governo Eletrnico
Sumrio
APRESENTAO...............................................................................................................................3
1.
2.
3.
4.
5.
6.
7.
8.
9.
APRESENTAO
Esse documento faz parte do e-VoG (Vocabulrios e Ontologias do Governo Eletrnico) que um
conjunto de padres, ferramentas e metodologias para possibilitar: o intercmbio de informaes
com acordo semntico, de forma a viabilizar o pronto cruzamento de dados de diversas fontes; o
uso de metodologias de modelagem conceitual como forma de elicitao do conhecimento tcito
das reas de negcio de governo; o uso de ontologias como ferramenta para explicitar
conhecimentos de maneira formal e coerente; o alinhamento conceitual das diversas reas do
conhecimento do governo.
Esse documento define direcionamentos para o uso de URIs no governo federal e pode e deve ser
revisto.
O enfoque para organizaes publicarem seus dados na poltica de dados abertos do governo
federal, com foco em reuso e dados linkados. Outras organizaes podem utiliz-lo para ajudar a
definir suas URIs em diferentes contextos.
Esse documento tem o seguinte pblico-alvo:
* Orgos pblicos federais que disponibilizam dados abertos;
* rgos com interesse em linkar seus dados com outros dados que no possuem controle;
* Pessoas interessadas em utilizar tais dados e informaes.
Para tanto uma definio poltica de URIs se torna necessrio alm do tempo de manuteno dessas
URIs e poltica de alteraes da mesma. Cada aplicao do governo deve se encarregar de definir o
tempo mnimo necessrio para de suas URIs.
Natureza do recurso
Separar as URIs que identificam recursos no-informacionais (objetos, conceitos abstratos) das
URIs que identificam recursos informacionais (documentos que podem ser transmitidos
digitalmente). Estas utilizaro valor doc para o slug {natureza-recurso} e aquelas o valor id. As
URIs do primeiro tipo devero sempre retornar o cdigo HTTP 303 (See Other), apontando para
uma do segundo tipo que descreva o objeto por cada uma delas identificado. Opcionalmente, poder
ser realizada a verificao de existncia do objeto antes do redirecionamento, retornando em vez
disso o cdigo HTTP 404, caso ele no exista na base de dados.
Caso utilize o valor id como slug {natureza-recurso} no ser permitido a utilizao de extenso
para especificar o formato desejado e sendo retornado HTTP 404 nesse caso.
Nas URIs que identificam recursos informacionais, usar negociao de contedo (Content
Negotiation) para escolher, dentre a interseo das representaes disponveis e aquelas que o
cliente aceita, aquela que o cliente tem preferncia. Caso essa interseo seja vazia, retornar o
Dentre as URIs que identificam recursos informacionais, usar URIs sem extenso e tambm com
extenso. As URIs sem extenso devero ser usadas via de regra, sendo a referncia persistente ao
documento identificado. As URIs com extenso sero usadas apenas como uma forma de facilitar o
download em um browser dos demais formatos (caso contrrio o usurio precisaria de uma
ferramenta especializada para essa simples tarefa), e identifica a verso naquele formato do recurso
informacional referenciado. Sempre que possvel, em cada representao, deve-se fornecer links
para as URIs com extenso que levam s representaes com formatos especficos.
Versionamento da API
A ltima verso da API ser acessvel nas URIs sem indicao de verso. Todas as verses,
inclusive as antigas, estaro disponveis nas URIs com indicao explcita de verso.
O slug opcional {versao_api} referente a verso da API e no referente a verso do recurso
identificado.
Os identificadores precisam ser uma chave que identifique unicamente um objeto dentre os seus
pares de mesma categoria. No necessariamente isso a chave primria do banco de dados.
Podemos usar o cdigo como identificador, uma vez que dificilmente haveria uma soluo legvel
para humanos e que diferencie todas as unidades que tm o mesmo nome.
Relacionamentos e links
Os relacionamentos entre objetos devem ser indicados nas representaes dos recursos, da maneira
mais adequada ao formato, e retornar no apenas o tipo do objeto apontado e o seu identificador
local (chave), como tambm a URI que identifica o recurso apontado.
Tambm devem ser retornados links para outras consultas que forem relevantes ao contexto. Por
exemplo, ao consultar os detalhes de uma natureza jurdica, incluir link para a consulta de todos os
rgos e entidades que tm aquela natureza jurdica.
http://estruturaorganizacional.dados.gov.br/[{versao_api}]/{natureza-recurso}/{conceito}[/
{identificador}|/{funcao}][/{referencia}][.{formato}]
{conceito}: orgaos-entidades, estrutura-organizacional, unidade-organizacional, poder, esfera,
natureza-juridica, endereco-contato
{dentificador}: secretaria-logistica-tecnologia-informacao
{funcao}: resumida, completa, filha
{referencia}: vinculadas, ?codigoesfera=1&ativo=sim
http://estruturaorganizacional.dados.gov.br/id/unidade-organizacional/1232
(identifica a SLTI, redireciona para a URI abaixo)
http://estruturaorganizacional.dados.gov.br/doc/unidade-organizacional/1232
(consulta individual que retorna informaes detalhadas sobre a SLTI, no formato resultado da
negociao de contedo)
http://estruturaorganizacional.dados.gov.br/doc/unidade-organizacional/completa.xml?codigounidade=1232
(consulta coletiva, usando a {funcao} completa, especificando o formato xml, e com o parmetro
codigo-unidade com o valor 1232. Obs.: uma consulta coletiva, mesmo que retorne apenas um
resultado, pois foi utilizado um slug do tipo {funcao} e no {identificador}.)
http://estruturaorganizacional.dados.gov.br/id/poder/executivo
(identifica o poder executivo, redireciona para o equivalente com o slug doc)
http://estruturaorganizacional.dados.gov.br/id/natureza-juridica/empresa-publica
(identifica a natureza jurdica de uma empresa pblica, redireciona para o equivalente com o slug
doc)
http://estruturaorganizacional.dados.gov.br/doc/poder?codigo-poder=1&ativo=nao
http://estruturaorganizacional.dados.gov.br/v2/doc/poder?codigo-poder=3&ativo=nao