Esta API disponibiliza, de forma pública, dados que são gerados pela Universidade Federal do Estado do Rio de Janeiro. A publicação dos dados em formato aberto permite que qualquer pessoa ou sistema desenvolva suas próprias aplicações ou visualizações para promover uma constante melhoria de serviço através da inovação, criatividade e transparência pública, permitindo uma maior interação da comunidade com a Diretoria de Tenologia da Informação e Comunicação (DTIC) da UNIRIO.

Segundo a definição da Open Knowledge Foundation, dados são abertos quando qualquer pessoa pode livremente usá-los, reutilizá-los e redistribuí-los. Isso geralmente é satisfeito pela publicação dos dados em formato aberto e sob uma licença aberta.

Os dados abertos também são pautados pelas três leis e oito princípios.

• Se o dado não pode ser encontrado e indexado na Web, ele não existe;
• Se não estiver aberto e disponível em formato compreensível por máquina, ele não pode ser reaproveitado;
• Se algum dispositivo legal não permitir sua replicação, ele não é útil.

Permissões de Acesso

Permissões de acesso liberam possibilidades de visualizações a dados restritos, assim como definem a quantidade de requisições diárias que podem ser feitas ao servidor.

Atualmente, as permissões são as seguintes:

• Aluno
• Professor
• Servidor
• Sistema
• Desenvolvedor
• Sistema Convidado
• Convidado
• Teste
• CEDERJ

Quem pode ter acesso a que?

Professores

Como ter acesso a mais dados?

Envie um email para sistemas.tic@unirio.br!

Ciclo de Vida

Sintaxe

Uma consulta a API é composta de 3 partes obrigatórias:

• URL base: http://sistemas.unirio.br/api
• Endpoint: /ALUNOS
• Parâmetro API_KEY: ?API_KEY=PBKDF2$sha256$10000$InTv75LNy8JrXuvx$Hhht/jloYXYlDWFkDVTS1qyIm7A8xIEh. Sendo essa só um exemplo.

Combinando os três elementos, resulta em uma consulta básica:

http://sistemas.unirio.br/api/ALUNOS?API_KEY=PBKDF2$sha256$10000$InTv75LNy8JrXuvx$Hhht/jloYXYlDWFkDVTS1qyIm7A8xIEh

Parâmetros Adicionais

Para os exemplos de uso abaixo, considere
URL_BASE=http://sistemas.unirio.br/api/ALUNOS?API_KEY=PBKDF2$sha256$10000$InTv75LNy8JrXuvx$Hhht/jloYXYlDWFkDVTS1qyIm7A8xIEh onde o exemplo URL_BASE&LMIN=100, seria equivalente a consulta:
http://sistemas.unirio.br/api/ALUNOS?API_KEY=PBKDF2$sha256$10000$InTv75LNy8JrXuvx$Hhht/jloYXYlDWFkDVTS1qyIm7A8xIEh&LMIN=100

Param	Description	Usage
LMIN	Dada uma determinada consulta, LMIN diz para a API que salte uma determinada quantidade de linhas. Default = 0. Funciona em conjunto com LMAX	&LMIN=integer
LMAX	Ao utilizar LMAX, dizemos a API que limite a quantidade de resultados. Note que o valor máximo possível será sempre limitado ao teto permitido para a sua API_KEY. Caso um valor maior do que este seja passado, o valor máximo então será atribuído. Funciona em conjunto com LMIN	&LMAX=integer
ORDERBY	Ordena os resultados da consulta por um determinado Field (ver descrição detalha de dados). Funciona em conjunto com o parâmetro SORT	&ORDERBY=string
SORT	Utilizada em conjunto com o parâmetro ORDERBY, pode receber o valor ASC para ordenação crescente ou DESC para decrescente.	&SORT=string
FORMAT	O tipo de visualização padrão dos dados é HTML. Formatos disponíveis são: JSON e XML	&FORMAT=string

Lembre-se: Parâmetros são descritos pela seguinte estrutura: &+NOME_DO_PARAMETRO=+valor. Por exemplo: &LMIN=10&LMAX=10000&FORMAT=JSON

Parâmetros restritivos

São parâmetros específicos para realização de uma consulta com intuito de restringir o conjunto geral de Endpoint para um subconjunto. Esses parâmetros são específicos de cada Endpoint e relacionados aos Fields ( veja os Fields disponívels para cada Endpoint aqui ) e tipo de dado Type de cada um.

Type	Description	Usage
String	Valores do tipo String (texto), utilizam-se de busca do tipo "está contido em". Ou seja, o valor passado para o parâmetro não precisa necessariamente ser idêntico ao que se espera no campo, ele só precisa estar presente. Em uma consulta por DISCIPLINAS cujo parâmetro NOME_DISCIPLIMA contenha a paralava CaLCulO, teríamos como resultado não somente "Cálculo", mas também 'Cálculo 1', 'Calculo 2', 'Calculo Diferencial Estrogonófico', etc. Note que esta busca é case insensitive, ou seja, letras maíúsculas e minúsculas são tratadas da mesma forma.	&NOME_DISCIPLINA=CaLCulO
Integer	Ao enviar um valor para um parâmetro do tipo inteiro, serão retornadas todas as linhas em que o Field contenha exatamente aquele valor numérico inteiro. Por exemplo, se quisermos retornar todos os alunos de cor branca, pediremos por todas as entradas do Endpoint ALUNOS com Field ETNIA_ITEM igual a 1	&ETNIA_ITEM=1
Date	Formatos do tipo date são definidos pelo padrão YYYY-MM-dd ANO-M. Fields do tipo data podem ser utilizados juntamente com os sufixos _MIN e _MAX	&DT_NASCIMENTO=1980-01-01 &DT_NASCIMENTO_MIN=1980-01-01 &DT_NASCIMENTO_MAX=1980-01-01
Time	Formatos de tempo são definidos pelo padrão HH:MM:SS e também podem ser utilizados juntamente com os sufixos _MIN e _MAX	&HR_INICIO_AULA=08:00:00 &HR_INICIO_AULA_MIN=08:00:00 &HR_INICIO_AULA_MAX=08:00:00
Float	Field do tipo float (ponto flutuante), ou números reais, são caracterizados pela presença do caracter ponto . para separação de casas decimais. Fields do tipo float podem ser utilizados juntamente com os sufixos _MIN e _MAX	&VL_CONTRIBUICAO=6000.50 &VL_CONTRIBUICAO_MIN=7500.75 &VL_CONTRIBUICAO_MAX=8000.8

Dados Disponibilizados

Quer contribuir?

• Encontrou alguma falha de segurança?
• Acha que poderia contribuir com a documentação?
• Quer requisitar alguma nova funcionalidade?

Envie sugetões para sistemas.tic@unirio.br