[1] O documento descreve o serviço de API do sistema CIÊNCIAVITAE, incluindo métodos disponíveis, organização do Swagger e acesso aos ambientes de qualidade e produção. [2] Os utilizadores podem aceder a informação sobre currículos através de métodos como /curriculum/{id} e realizar pesquisas usando /searches. [3] O acesso está sujeito a níveis de privacidade e autorização do titular do currículo.

1. Documento de Apoio ao Serviço de API

2. Contexto

3. 4. O titular do currículo pode, sempre que queira, alterar o nível de
privacidade dos registos
CIÊNCIAVITAE
1. O titular do currículo regista a informação em sete áreas funcionais
distintas:
3. O titular do currículo pode divulgar o seu currículo na plataforma:
2. A semântica implementada na plataforma é adaptada do dicionário
CASRAI*;
Sistema CRIS
* Similar ao ORCiD
** Vide Acesso aos
currículos
Acesso**
Autorizado
Público

4. Níveis de privacidade
Entidades
(autorizadas pelo titular)
Gestores
(nomeados pelo titular)
Todos
Público
Semi-público
Privado

5. Contexto

6. Módulo Institucional
Serviço de Indicadores Institucionais Serviço de API
Gabinete de gestão Sistema CRIS
Leitura e escrita*Leitura
*Vide Acesso aos currículos

7. Serviço de API
Ambiente Qualidade Ambiente Produção
Endereço https://qa.cienciavitae.pt/docs/ https://api.cienciavitae.pt/docs/
Base URL qa.cienciavitae.pt/api api.cienciavitae.pt/
Utilizadores Demo Reais
124* 23 703*
*10.12.2019
**Credenciais diferentes
para os dois ambientes
CVs criados
58* 13 952*CVs publicados
Credenciais Mediante pedido** Mediante resposta a formulário**
Âmbito Testes de integração Integração com CRIS
Privacidade
Tipo acesso Leitura pública
Leitura autorizada
Leitura e escrita autorizadas
Leitura pública
Leitura autorizada
Leitura e escrita autorizadas

8. Acesso aos currículos
1. O acesso aos currículos é feito mediante autorização do titular do
currículo*/**;
*Em linha com o novo
RGPD.
**Não se aplica ao acesso a
informação “Pública” de
currículos publicados.
2. O acesso via API está condicionado a sistemas CRIS que tenham a
capacidade de implementar a respectiva janela de autorização**:
3. A integração é feita através de link:
/cv/add-privilege/<username_api>

9. Autenticação

10. Organização do swagger
Informação de suporte ao serviço
(schemas) e autenticação
Métodos (N=28)
Modelos (N=197)

11. Organização schemas

12. Organização do swagger
Informação de suporte ao serviço
(schemas) e autenticação
Métodos (N=28)
Modelos (N=197)

13. Idiomas
Parametrizável:

14. Organização Métodos

15. Organização Métodos
Parametrização
Execução
Exemplo de resposta e erros

16. Métodos disponíveis
/v1.1/api-user
/v1.1/api-user/{ciencia-id}/access-privileges
/v1.1/curriculum/{ciencia-id}
/v1.1/curriculum/{ciencia-id}/METADADO
/v1.1/curriculum/{ciencia-id}/METADADO/{id}
/v1.1/curriculum/employment-items
/v1.1/searches/institutions
/v1.1/searches/persons
/v1.1/searches/persons/institution
/v1.1/searches/statistics
Recolher
Adicionar
Atualizar
Eliminar*
Ações
Métodos
*Limitada a acesso
autorizado

17. Métodos disponíveis
/v1.1/api-user
Informação sobre as condições de acesso
Público ou Público e Semi-público
Leitura pública ou Leitura autorizada ou Leitura e escrita autorizadas

18. Métodos disponíveis
/v1.1/api-user/{ciencia-id}/access-privileges
Informação sobre o acesso permitido a um determinado currículo
Sem autorização* Com autorização* *Vide Acesso aos currículos

19. Métodos disponíveis
Currículo completo* de um determinado utilizador
/v1.1/curriculum/{ciencia-id}
*Condicionado ao acesso
autorizado
** A pré-geração ocorre
sempre que há edição
Os currículos estão pré-gerados** para maior rapidez na resposta.

20. Métodos disponíveis
Ações sobre metadados específicos com indicação da proveniências dos dados
/v1.1/curriculum/{ciencia-id}/METADADO
/v1.1/curriculum/{ciencia-id}/METADADO/{id}
Identificadores de
autor
Nomes de
citação
Formação Distinções/Prémios Áreas do conhecimento
FOS*
Endereços de
e-mail
author-identifier citation-name degree distinction domain-activity email
Afiliações Projetos Endereços web Identificação e idiomas Idiomas Moradas
employment funding websites Identifying info language-competency mailing-address
Produções
PDF do
currículo
Dados pessoais Contactos telefónicos Resumo Atividades
outputs pdf person-info phone-number resume service
Versões do CV**
versions
*CDCT, 2007
**Apenas em QA

21. Métodos disponíveis
Listagem de categorias profissionais
/v1.1/curriculum/employment-items

22. Métodos disponíveis
Informação sobre as instituições registadas com identifier Ringgold*
/v1.1/searches/institutions
*Identify database Ringgold
**Mapeada à autenticação na
API
Informação sobre IDENTIFICAÇÃO/PERCURSO PROFISSIONAL com pesquisa por
nome
/v1.1/searches/persons
/v1.1/searches/persons/institution
Informação sobre IDENTIFICAÇÃO/PERCURSO PROFISSIONAL com pesquisa por
instituição**
/v1.1/searches/statistics
Informação global sobre o número de pessoas/projetos/artigos em
revista/instituições registados no CIÊNCIAVITAE

23. Organização do swagger
Informação de suporte ao serviço
e autenticação
Métodos (N=28)
Modelos (N=197)

24. Organização Modelos
* Obrigatoriedade na inserção
Tipo do metadado
Atributos
Valores
etc.

25. Erros devolvidos
200 Successful operation GET/PUT bem sucedido
201 {} created, see HTTP Location header for Record Identifier POST bem sucedido
204 {} deleted DELETED bem sucedido
400 Invalid Ciência ID O CIÊNCIA ID não existe
401 Service authentication credentials are required Não foi feita autenticação no swagger
403
Forbidden operation for the given authentication credentials
Access forbidden for unpublished curriculum
Ação não é permitida para a autenticação feita
404
Invalid format for Ciência ID
Record identifier not found
Formato introduzido está errado
{id} não existe
409 Conflict Registo já existe no currículo
429 Too many requests Elevado número de pedidos ao serviço
500 Internal server error Erro

26. Acesso ao ambiente de Produção
1. Esgotados todos os testes em QA;
2. Submeter pedido no formulário de contacto com o assunto “API”;
3. Será enviado formulário para aferir contexto do acesso;
4. Pedido será: deferido, deferido com alterações ou indeferido.
As instituições são inteiramente responsáveis por toda a
informação que registam/alteram nos currículos dos
utilizadores

27. Apoio
Não existe um serviço de helpdesk dedicado a prestar assistência à utilização da
API.
Todas as questões devem ser colocadas via formulário de contacto com o
assunto “API”.

28. Formulário