Estudante ID

INTEGRAES COM SISTEMAS ACADMICOS

DOCUMENTO TCNICO
INTEGRAES COM SISTEMAS ACADMICOS

1.Principais relaes do Estudante ID com as IES

O objetivo do presente documento a sistematizao dos relacionamentos entre o sistema
Estudante ID e as Instituies de Ensino Superior (IES), sobretudo com os sistemas de Gesto
Acadmica.

2.Comunicao do Estudante ID IES

Um dos principais objetivos da construo de um identificador para os estudantes do Ensino Superior
que em torno dele sejam registadas e realizadas as trocas de informao relacionadas com o
estudante.

Nesta perspetiva, o conhecimento por parte da IES do Estudante ID condio essencial para a
realizao, no futuro, de qualquer associao ou tratamento de informao de um estudante, sendo
este o identificador distinto, nico e persistente de estudante do Ensino Superior nacional.

Para transmitir esta informao IES esto j previstos vrias opes que a seguir se descrevem:

2.1. Fornecido em listagem oficial

Previsto, por exemplo, por via do Concurso Nacional de Acesso em que a listagem de alunos
fornecida IES pela DGES.

O Estudante ID dever constar da lista, em substituio do carto de identificao e de outros

cdigos gerados para os alunos estrangeiros. Para outros dados de identificao, logo que todo o
sistema esteja preparado, deve ser considerada a sua remoo, dado que esta funo cumprida
pelo identificador, com aumento da privacidade.

A forma de aceder aos restantes dados, antes fornecidos na lista de mbito externo (dado que no
informao considerada dentro do Estudante ID), devendo ser necessrio gerar aqui algumas
funes especficas de interoperabilidade para obter diretamente nos sistemas da IES, os dados do
aluno (prev-se um webservice para receber os dados relevantes de cada aluno admitido, assim
como outro para atualizao de dados em mbito de concurso).

2.2. Na relao direta entre o Estudante e a IES

A considerar no primeiro momento de identificao do aluno, por processo eletrnico, presencial ou
virtual (e.g., nos sistemas de candidatura e/ou de matrcula/inscrio).

Estudante ID documentao tcnica verso de 2017.07 preliminar - Pgina 1 de 8

 Estudante ID
INTEGRAES COM SISTEMAS ACADMICOS

A IES apresenta ao aluno um boto de acesso para uma pgina de Associao/Consentimento. Essa
pgina um servio do Estudante ID que exige autenticao e devolve IES o identificador, caso a
operao seja validada (estudante que se autentica. vlido que seja simultaneamente um novo
registo de Estudante ID).

Dados tcnicos:

- cada IES necessita de estar devidamente identificada no sistema de Estudante ID;

- o mecanismo de chamada realiza-se mediante protocolo seguro associando um cdigo de pedido, a

identificao e uma encriptao protocolada;

- O sistema Estudante ID apresentar ao estudante uma mensagem protocolada para que este esteja
consciente do acesso e utilizao prevista dos seus dados. Pode haver aqui opes de acesso que o
utilizador possa desativar, sem que tal ponha em causa a necessria transmisso do Estudante ID
IES que o solicita;

- Por aceitao do estudante e aps correta autenticao, considerada completa a operao e

respondido ao servio da IES que solicitou o Estudante ID em causa.

2.3. Usufruindo dos dados oficializados da IES (via transitria)

Esta uma situao transitria, que usufrui do conhecimento que a IES tem dos dados oficiais de
identificao do aluno.

Este mdulo deve ser desenvolvido em ligao estreita com as IES que para tal apresentarem
interesse, dada a dependncia de informao e comportamento dos seus sistemas de informao.

Para simplificao, reduz-se a um nico processo, que surge como mais consensual, seguro e efectivo.

2.3.1. Processo por login na IES

A IES j tem o processo do aluno aberto, podendo ser essa uma fonte oficial de dados de
identificao para a abertura de um Estudante ID.

Quer mediante convite por outro canal, quer por disponibilizao dentro dos sistemas da IES, o aluno
estimulado a criar um registo de Estudante ID. No mbito dos sistemas da IES o aluno autntica-se
e solicita a abertura do Estudante ID.

A partir do momento em que o estudante j est numa sesso segura do sistema da IES, possvel
confrontar a abertura de um novo Estudante ID e usufruir da informao passada pela IES,
informao essa que foi j validada.

Aps criao do Estudante ID o controlo devolvido ao sistema da IES, assim como o identificador
atribudo ao aluno.

Estudante ID documentao tcnica verso de 2017.07 preliminar - Pgina 2 de 8

 Estudante ID
INTEGRAES COM SISTEMAS ACADMICOS

3.Uso do Estudante ID pelas IES

Acesso por entidades reconhecidas no sistema (IES), mesmo sem consentimento explcito do
estudante.

3.1. Atualizao de Factos relevantes do Estudante

Uma IES que tenha factos sobre um estudante deve atualizar o histrico do Estudante ID, sempre que
tal seja possvel.

Para inserir e atualizar factos necessrio ter o Estudante ID do estudante em causa.

Na posse do correto Estudante ID (que identifica o estudante sobre o qual se pretende inserir, alterar
ou remover factos), a IES pode executar chamadas aos webservices de FACTOS.

Para todos estes webservices possvel passar o parmetro transactionID (identificador de uma
anterior operao de insero de um facto especfico), sendo nesse caso uma operao de
ALTERAO de um facto j existente.

tambm possvel cancelar uma insero de factos, sendo obrigatria a passagem de um texto de
justificao de cancelamento.

3.2. Recuperao de histrico - IES tem identificao mas no Estudante ID

No incio de explorao do sistema, a IES no detm o Estudante ID, mas tem dados de identificao
do estudante. Ao validar a identidade do estudante (usando o webservice wsValidarID), resulta:

- existe o Estudante ID - a IES recebe o correspondente identificador (ficando na situao do

ponto 3.1);
- no existe o Estudante ID - passa ao modo recuperao de histrico para esta identificao
de estudante.

O protocolo proposto para o modo recuperao de histrico pretende:

permitir que uma IES que tem factos mas ainda no conhece o Estudante ID possa evoluir
para a integrao do histrico;
evitar o excesso de dados pessoais a serem geridos sem Estudante ID especificado;
evitar o excesso de informao a circular entre IES e o Estudante ID.

Para a recuperao de histrico so propostos os seguintes webservices:

3.2.1. wsValidarID
Validao de identidade e registo para histrico

Estudante ID documentao tcnica verso de 2017.07 preliminar - Pgina 3 de 8

 Estudante ID
INTEGRAES COM SISTEMAS ACADMICOS

Permite IES o envio de dados de identificao de um aluno sobre o qual tem factos histricos;

A identificao necessria a uma boa identificao :

Nacionalidade
Tipo de documento lista j definida acresce NIC para nmero de identificao sem
check digit (para PT)
ID do documento
Segundo elemento: um dos seguintes valores obrigatrio ser enviado
o Data de Nascimento - preferencial
o Nome somente caso a data de nascimento no seja conhecida
Se os dados enviados apresentarem erros, devolvida somente a mensagem de erro sobre dados de
identificao;

Se esses dados forem considerados coincidentes com um Estudante ID existente, devolvido o

Estudante ID e nesse caso no gerado um registo de histrico;

Se no existir o identificador, devolvido um TransactionID que permite IES perceber qual o registo
aberto;

No pedido, a IES envia o nmero total de factos contabilizados como histrico total do estudante;
Este valor serve objetivos estatsticos e de gesto do sistema, no sendo em qualquer outro
momento confrontado com o envio de factos;

Se a IES repetir o mesmo pedido com os mesmos dados de identificao, o sistema devolve o mesmo
transactionID, pelo que tambm pode ser usado para alterar o nmero de factos contabilizados.

3.2.2. wsHistoricoLista
Das identificaes em recuperao de histrico devolvida uma lista dos Estudantes ID entretanto
disponveis associados aos correspondentes TransactionID (devolvidos aquando da chamada a
wsValidarID).

Para a IES que coloca o pedido, o sistema responder com a lista dos primeiros X registos (entretanto
abertos) de Estudante ID que passam a ser conhecidos pela IES e assim permite serem atualizados; A
lista ser composta por duas colunas: Estudante ID e TransactionID;

Este mtodo deve ser chamado com a frequncia conveniente de forma a conhecer os novos
Estudantes IDs gerados no sistema e tendencialmente terem uma atualizao atempada;

Para cada novo Estudante ID existente nesta lista deve a IES despoletar as chamadas dos webservices
disponveis para a insero de factos, de acordo com o seu tipo.

Estudante ID documentao tcnica verso de 2017.07 preliminar - Pgina 4 de 8

 Estudante ID
INTEGRAES COM SISTEMAS ACADMICOS

3.2.3. wsHistoricoRemover
Remover entrada de Histrico

Permite IES remover uma entrada de identificao, com base no transactionID, e assim deixar de
constar desta gesto de histrico.

4.Webservices
4.1. Histrico
Funcionalidade dos web-services j descritos no documento.

4.1.1. wsValidarID

4.1.2. wsHistoricoLista

4.1.3. wsHistoricoRemover

4.2. Factos
4.2.1. wsFactoInscricao
Este servio permite registar a inscrio de um aluno numa instituio do ensino superior.

4.2.2. wsFactoGrau
Este servio permite inserir graus/conferir diplomas aos estudantes

4.2.3. wsFactoErasmus
Este servio permite inserir nos factos do estudante a actividade Erasmus.

4.2.4. wsFactoBolsa
Este servio permite registar nos factos do estudante se este teve direito a bolsa.

4.2.5. wsFactoEstatuto
Este servio permite registar nos factos do estudante qual o seu estatuto na instituio de ensino.

4.2.6. wsFactoVoluntariado
Este servio permite registar nos factos do estudante a atividade de voluntariado.

4.2.7. wsFactoEstagioExtraCurricular
Este servio permite registar nos factos do estudante estgios extracurriculares.

Estudante ID documentao tcnica verso de 2017.07 preliminar - Pgina 5 de 8

 Estudante ID
INTEGRAES COM SISTEMAS ACADMICOS

4.2.8. wsCancelarFacto
Este servio permite inativar qualquer entrada efetuada pelos servios anteriores, usando o
identificador da transao. O registo no apagado mas deixa de surgir no histrico correspondente,
passando a um estado de inativado com razo de inativao associada.

4.2.9. wsECTSrealizados
Aps registo de uma inscrio (na qual se definiu o numero de ECTS que o aluno se prope realizar)
esta chamada permite (supostamente aps concluso dessa inscrio) a actualizao dos ECTS
realmente realizados.

Dado que este controlo de ECTS se destina a facilitar os processos de concesso de bolsas, e para
facilitar a gesto, prev-se a chamada deste servio sempre que existe uma alterao do valor ECTS
no processo do aluno.

4.2.10. wsListarFactos
Permite IES recuperar a lista de factos que colocou num dado Estudante ID.

Est previsto um modo de acesso em que, caso a IES tenha consentimento do aluno, lhe seja
permitido recuperar todos os factos relevantes do historial do Estudante, at ao momento do
consentimento.

4.2.11. wsFrequentaEnsinoSuperior
Este servio permite informar se num perodo de referncia (entre duas datas fornecidas) o aluno em
causa estudante efetivo (com uma inscrio vlida) no Ensino Superior.

Caso a data referida seja coincidente com a data definida para termino da inscrio, considera-se que
frequenta o ensino superior data.

4.3. Tokens uso no previsto nas IES

4.3.1. wsValidarToken
Usado no mbito do mdulo Validao por Chave (token).

A chave enviada ao Estudante ID pode provocar vrios nveis de resposta de acordo com o protocolo
convencionado.

A resposta dada pelo sistema constitui-se sempre com caracter oficial.

5.Estrutura do Transaction ID
Para cada operao que gere algum tipo de registo no Estudante ID, por parte da entidade
(nomeadamente as IES), gerado um identificador nico que permita recuperar e associar
entidade tal operao.

Estudante ID documentao tcnica verso de 2017.07 preliminar - Pgina 6 de 8

 Estudante ID
INTEGRAES COM SISTEMAS ACADMICOS

A construo interna baseada em "Extended Hex" Base 32 (de acordo com RFC 4648) ou
considerado Base32 do RFC 2938: 0 corresponde a zero; V corresponde a 31.

Dado que se procurou alguma facilidade na legibilidade, no se reduziu os smbolos que podem criar
alguma confuso, pelo que, sempre que esteja em causa a capacidade de leitura, recomenda-se o
uso de uma fonte monoespaada e que distinga claramente 0 de O, 1 de i, de l, etc.

A estrutura definida para o transactionID apresenta um preambulo, que se recomenda preservar,

podendo em situaes limite de optimizao de espao ser removido e ser considerado tacitamente
existente. Nestes casos exigido a construo do transactionID completo antes de qualquer
comunicao com o Estudante ID.

Considerando uma transao com a entidade protocolada com o cdigo 35, um exemplo de
transao

TEID035010FVGOMPIUQ

Neste transactionID existe o preambulo que estar fixo e presente em todas as transaes com esta
entidade:

Prefixo: TEID035

Cdigo nico desta transao: 010FVGOMPIUQ

Os trs dgitos seguintes representam o objeto sobre o qual gerado o identificador de transao.
um valor interno ao sistema e pode no ter uma correspondncia conhecida.

No restante bloco (FVGOMPIUQ) a construo orientada para uma zona que representa a
serializao temporal (que permite com os atuais 10 dgitos representar momentos at cerca do ano
2050, com rigor de milissegundos) acrescido de dois dgitos pseudoaleatrios.

possvel converter o identificador no momento em que foi gerado:

TransactionID TEID035010FVGOMPIUQ
Prefix TEID
Base32 Dec
Entity 035 101
Object 01 1

Temporal 1716390174
0FVGOMPI
mark 6
2107-7-18 15:45:1 '
Moment
746
Date 2107-07-18 198

Estudante ID documentao tcnica verso de 2017.07 preliminar - Pgina 7 de 8

 Estudante ID
INTEGRAES COM SISTEMAS ACADMICOS

Time 15:45:01
hour 15
min 45
sec 01
sec 746 746
random mark UQ 986

Pode ainda ser usado o valor numrico do bloco aps prefixo e identificador de entidade, sendo que
este valor usa 12 dgitos em base 32 e consequentemente menos de 64 bits. Para este
armazenamento no deve ser usado estruturas de dados com virgula flutuante, mas sim valores
inteiros.

6.Documentos associados
6.1. Web-services para IES
(a inserir)

6.2. Data structures for Web-services

(a inserir)

Estudante ID documentao tcnica verso de 2017.07 preliminar - Pgina 8 de 8