API REST – Description du niveau de service

Ce document constitue une description du niveau de service offert dans le cadre de la mise en service de l’API REST développée par le Centre d’expertise numérique pour la recherche (ci-après le « CEN-R »). Le document détaille :

• L’utilisation qui peut être faite de l’API REST
• Le niveau général de réponse, de disponibilité et de maintenance associés à l’utilisation de l’API REST
• Les responsabilités du CEN-R en tant que concepteur de l’API REST
• Les responsabilités de l’unité organisationnelle (ci-après « Utilisateur » ou Utilisateurs) utilisatrice de l’API REST

La Description du niveau de service peut être révisée. Toute révision sera diffusée par le biais d’un envoi écrit à la liste de diffusion SADVR : sadvr-api@listes.umontreal.ca. Pour les modalités d’abonnement à la liste de diffusion, on consultera la section 4 du présent document.

En 2016-2016, dans le cadre du projet SADVR (service d’accès aux données de la Vitrine-Recherche), une API REST a été développée par l’équipe du CEN-R afin de redistribuer les données des entités Individu (personnel enseignant) et Unité de recherche contenues dans le dépôt Vitrine-Recherche. Ces données de type « publiques » sont accessibles à tout Utilisateur souhaitant en faire usage pour ses besoins administratifs et de communication.

L’API est constituée de 3 services distincts qui, lorsque combinés entre eux, permettent de récupérer un ensemble plus ou moins grand de données à l’aide de requêtes HTTP. Les réponses retournées sont en JSON.

Les services proposés sont les suivants :

• Un service d’exposition des ressources
• Un service de recherche d’identifiant pérenne (idsadvr) pour un individu ou une unité de recherche
• Un service de récupération de données pour un individu ou une unité de recherche par le biais d'un identifiant pérenne
• Un service de moteur de recherche dans des index qui permet de servir un outil de recherche en mode simple ou par critère

Pour plus de détails sur l’API REST SADVR, on peut consulter la documentation disponible en ligne sur l’Espace documentaire CEN-R : http://www.cen.umontreal.ca/espacedoc/sadvr/apirest/

2.1  Portée du service

Le service offert couvre :

• La redistribution des données publiques des entités Individu et Unité de recherche conservées dans le Dépôt Vitrine-Recherche
• La maintenance et la gestion de l’API REST (rétrocompatibilité, gestion de versions, maintenance des versions antérieures non rétrocompatibles pour une période de 2 ans)
• Le traitement des requêtes et avis d’incident (bogues, améliorations et nouvelles fonctionnalités) liés à l’utilisation de l’API REST
• La production et la mise à jour du matériel documentaire nécessaire à l’utilisation de l’API REST

Le service ne couvre pas :

• Les développements nécessaires à l’interrogation de l’API REST

3.1  Responsabilités du CEN-R

Le CEN-R fournit l’infrastructure, la technologie, les ressources humaines et la surveillance nécessaires à l’API REST développée.

• Avise les Utilisateurs des interventions et coupures de services de l’API REST par un envoi écrit à la liste de diffusion SADVR-API (sadvr-api@listes.umontreal.ca) avec un préavis de 48 heures
• Avise les Utilisateurs, avec un préavis minimum de 48 heures ouvrables, de toute intervention de maintenance (sauf en cas d’urgence) par un envoi écrit à la liste de diffusion SADVR-API.  Pour s’abonner à la liste, on peut consulter la page d’accueil de la liste (http://www.listes.umontreal.ca/wws/info/sadvr-api) ou écrire à l’adresse : sadvr@cen.umontreal.ca
• Développe, gère et maintien l’API REST (rétrocompatibilité, gestion de versions, maintenance des versions antérieures non rétrocompatibles pour une période de 2 ans).
• Gère et traite les requêtes et les avis d’incidents (bogues, améliorations, nouvelles fonctionnalités) liés à l’utilisation de l’API REST
• Redistribue par le biais de l’API REST l’intégralité des données conservées dans le dépôt Vitrine-Recherche pour chacun des types de données identifiés comme « pouvant faire l’objet d’une redistribution » :
  
  • En conformité avec les Politiques et Règlements de l’Université de Montréal[1]
  • En indiquant le consentement (acceptation/refus) à l’affichage des données pour chacun des individus et unités de recherche visés par la redistribution

Pour plus de détails sur l’API REST SADVR, on peut consulter la documentation disponible en ligne sur l’Espace documentaire CEN-R : http://www.cen.umontreal.ca/espacedoc/sadvr/apirest/

Les mises à jour majeures de l’API REST (p. ex : conception d’un nouveau service) ne sont pas incluses dans le Niveau de service tel que défini dans le présent document. Ces mises à jour devront être traitées comme un projet distinct.

3.2  Responsabilités de l’Utilisateur

Dans le cadre de cet accord, l’Utilisateur :

• Utilise l’API REST.
• Développe, gère et maintien les applications nécessaires à l’interrogation de l’API REST Exploite les données des individus et unités de recherche visées par la redistribution :
  • En conformité avec les Politiques et Règlements de l’Université de Montréal [2]
  • En conformité avec le consentement à l’affichage des individus et unités de recherche visés par la redistribution – n’affiche pas sur son site Web ou sur tout autre site Web les données d’un individu ou d’unité de recherche n’ayant pas consenti à l’affichage des données.
• Utilise le matériel documentaire disponible en ligne sur l’Espace documentaire du CEN-R pour se former à l’utilisation de l’API REST : http://www.cen.umontreal.ca/espacedoc/sadvr/
• Utilise le Formulaire d’aide SADVR pour la transmission de ses requêtes et avis d’incidents.
• S’abonne à la liste de diffusion SADVR (sadvr-api@listes.umontreal.ca) pour être informé des interventions et coupures de services.

Le CEN-R n’offre pas de service de support par téléphone.

Les Utilisateurs peuvent se référer au matériel documentaire disponible en ligne sur l’Espace documentaire du CEN-R pour l’utilisation de l’API REST ou recourir au Formulaire d’aide pour les requêtes et rapports d’incident. Le formulaire en ligne peut être envoyé 24 heures sur 24, 7 jours par semaine. Les formulaires reçus sont traités dans un délai de deux jours ouvrables, sauf en période estivale où le délai est de 3 jours ouvrables.

Il est également recommandé de s’abonner à la liste de diffusion SADVR-API (sadvr-api@listes.umontreal.ca) pour être informé des périodes de maintenance ou des interruptions de service. Pour s’abonner à la liste, on peut consulter la page d’accueil de la liste de diffusion,

http://www.listes.umontreal.ca/wws/info/sadvr-api,

ou écrire à l’adresse suivante : sadvr@cen.umontreal.ca.

4.1  Information

Pour toute question relative au niveau de service décrit dans le présent document, on peut consulter la documentation disponible en ligne sur l’Espace documentaire du CEN-R (http://www.cen.umontreal.ca/espacedoc/sadvr) ou écrire à l’adresse suivante : sadvr@cen.umontreal.ca.

5.1  Maintenance

Tous les services et leurs composantes nécessitent des périodes de maintenance planifiées (fenêtre de maintenance) afin d’atteindre les niveaux de service établis. Ces activités pourront rendre le service et/ou les applications indisponibles durant les périodes suivantes :

Un maximum d’une plage horaire par semaine sera utilisé pour les opérations de maintenance. Dans des circonstances exceptionnelles, si une mise à jour doit être faite à un autre moment de la journée, un avis sera diffusé au préalable via la liste SADVR-API.

L’API REST développée dans le cadre du projet SADVR est libre de droits.

Pour plus de détails sur l’API REST du SADVR, on peut consulter la documentation disponible en ligne sur l’Espace documentaire du CEN-R : http://www.cen.umontreal.ca/espacedoc/sadvr/apirest/.