API service web accès sécurité
Guide concernant les organismes receveurs (GCOR)
Sommaire:
Les utilisateurs autorisés peuvent utiliser ce service Web pour obtenir les données à jour des étudiants ayant besoin d'un accès informatique dans le cadre de leur stage à venir pour leur site. En plus des noms des étudiants et des dates et lieux de stage, la liste comprendra les adresses courriel des étudiants si les adresses courriel attribués par l'établissement ont été divulguées aux organismes receveurs.
Généralités
Avec son consentement, le nom d'un étudiant est divulgué aux organismes receveurs, en général une fois que le stage a été accepté par le site et confirmé par l'organisme demandeur (établissement d'enseignement). L'adresse courriel attribuée à l'étudiant par l'établissement d'enseignement sera également divulguée si :
- l'étudiant a un compte HSPnet et entre son consentement à la divulgation de son adresse courriel aux personnes-ressource du site; ou
- l'organisme demandeur a activé la fonctionnalité de divulguer l'adresse courriel de l'étudiant automatiquement par le biais de l'assistant de rapport « Liste d'accès/sécurité » qui est disponible pour les organismes receveurs. Veuillez vous référer au guide de consultation rapide intitulé Divulgation de l'adresse courriel pour l'accès informatique pour activer cette fonctionnalité.
Une interface de programmation d'application (API) spécifie comment 2 systèmes d'informations peuvent échanger des données. HSPnet offre une API service web aux organismes receveurs qui souhaitent automatiser l'obtention des données disponibles par le biais de leur assistant de rapport « Liste d'accès/sécurité », par un fichier XML.
Autorisation d'un utilisateur
Une personne désignée devra posséder un compte utilisateur actif ayant un niveau d'accès administrateur local et pourra ainsi accéder au service web et sera responsable de l'utilisation de celui-ci. Les comptes utilisateurs partagés ne sont pas autorisés conformément aux politiques nationales de HSPnet. Chaque compte utilisateur doit avoir une adresse courriel non partagée pour la livraison sécurisée de mots de passe ou la communication venant du centre d'assistance.
Le compte devra être autorisé par un cadre supérieur de l'organisme receveur avec un rôle organisationnel incluant les stages aux site(s) demandé(s). Typiquement, cette personne est déjà identifiée dans HSPnet comme étant la personne-ressource pour le département afin d'autoriser de nouveaux comptes utilisateurs de niveau d'accès administrateur local.
Toute demande d'accès devra se faire auprès du centre d'assistance de HSPnet à assistance@hspcanada.net. Merci d'inclure les informations suivantes :
- Nom, rôle et adresse courriel de la personne-ressource pour le département ou le directeur autorisant l'accès au service web
- Nom du service web devant être utilisé – par ex. « API-001 Liste d'accès/sécurité »
- Nom, rôle et adresse courriel de la personne
- Sites, services, destinations et disciplines devant être incluses dans le fichier XML
- Date de démarrage souhaitée – prévoir au minimum 5 jours ouvrés
- Une demande pour un mot de passe sans expiration si la connexion sera automatisée
Accéder au service web
Les utilisateurs autorisés obtiendront l'URL pour leur province, leur service web, et leur nom d'utilisateur :
https://serveurlocal/HSPnetxx/WebServices/PlacementService.asmx/SecurityAccess?user=VOTRENOMDUTILISATEUR&pw=VOTREMOTDEPASSE&RAList=n/a&Start=2020/Jul/01&End=2020/Aug/31
Les variables ci-dessus doivent être spécifiées lors de chaque connexion par le service web :
|
serveurlocal
|
Sera fourni par le centre d'assistance pour chaque nouveau compte de service web
|
|
HSPnetxx
|
|
|
VOTRENOMDUTILISATEUR
|
Nom d'utilisateur HSPnet envoyé par courriel à la création du compte
|
|
VOTREMOTDEPASSE
|
Mot de passe permanent choisi par l'utilisateur à la première connexion
|
|
2020/Jul/01
|
Première date de la période à inclure (en anglais)
|
|
2020/Aug/31
|
Dernière date de la période à inclure (en anglais)
|
Données en sortie du service web
Le service web produira un fichier XML de tous les stages HSPnet qui sont actifs dans l'intervalle de temps spécifié, si un étudiant y a été affecté ET son nom a été divulgué à l'organisme receveur. Un stage sera considéré comme actif dans l'intervalle de temps spécifié si l'une des dates du stage est comprise dans cet intervalle (voir le diagramme).
Les conditions pour la divulgation du nom d'un étudiant sont les suivantes :
-
La demande de stage a le statut d'accepté (par l'organisme receveur) ou confirmé (par l'organisme demandeur);
-
Un étudiant est affecté au stage par l'organisme demandeur;
-
Le consentement de l'étudiant à divulguer ses informations personnelles n'a pas expiré;
-
Le nom de l'étudiant est divulgué à l'organisme receveur :
- de manière automatique lorsque le stage est confirmé;
- avant la confirmation du stage si le nom de l'étudiant est divulgué en avance par l'organisme demandeur conformément aux politiques de HSPnet.
Le fichier XML est constitué d'un ou plusieurs éléments <PlacementSecurityAccess> contenant chacun les champs de données tels que définis dans l'annexe 1. Les catégories de données sont les suivantes (en anglais dans le document XML) :
- Organisme demandeur (Placing Agency) – Organisme, corps enseignant ou département, programme d'études et discipline
- Informations sur le stage (Placement Information) – numéro de référence unique Pour un stage de groupe (2 étudiants ou plus), la même référence sera utilisée pour chaque étudiant affecté., type de stage et dates de début et de fin pour chaque étudiant.
- Enseignant (Instructor) – nom et coordonnées de la personne qui supervise les étudiants dans le cas d'un groupe mené par un enseignant Typiquement, l'enseignant dirigeant le groupe nécessite aussi un accès informatique. Au Québec, quelques programmes d'études peuvent demander à l'organisme receveur d'affecter un moniteur qui est un employé du site., ou qui est affecté en tant que facilitateur ou personne-ressource pour un stage individuel
- Étudiant (Student) – nom de l'étudiant affecté au stage, et adresse courriel si elle est divulguée par l'organisme demandeur.
Voici un exemple des données XML en sortie affichées dans un navigateur :
Messages d'erreur
Le service Web peut donner les messages d'erreur suivants (en anglais) :
|
Message d'erreur
|
Cause de l'erreur
|
|
User ID or password is invalid. You have xx login attempts remaining before this user account is locked out.
|
Nom d'utilisateur et/ou mot de passe invalide
(4 premiers essais infructueux)
|
|
Your account has been disabled. To reactivate your account, contact your HSPnet Local Administrator for your organization or contact support@hspcanada.net
|
Nom d'utilisateur et/ou mot de passe invalide
(5ème essai infructueux et essais suivants)
|
|
Access Denied
|
Le nom d'utilisateur n'est pas autorisé à accéder au service web
|
Information importante sur le numéro d’identification HSPnet pour les étudiants et enseignants
