Historique de la page

Connecteur appelé par le module card-eu. Il doit retourner les données de l'étudiant(e) issues de l'ESC Router (https://router.europeanstudentcard.eu/) agrémentées de données supplémentaires issues provenant de votre SI.

Pour information :

L'API ESC ROUTER ne renvoie par défaut que les données suivantes :

...

Donc, vous l'aurez compris, si vous souhaitez utiliser l'affichage étendu, il va falloir recouper avec des informations supplémentaires. La documentation suivante ne concerne donc que la mise en place d'un connecteur pour l'affichage étendu.

Paramètres d'appels

URL en méthode GET :

<host>/<uri>/<username>

• host : adresse du serveur
• uri : chemin éventuel vers le service
• username : identifiant (login) de l'utilisateur pour lequel on souhaite les informations, soit l'utilisateur qui se connecte.

Pas de paramètres ou headers particuliers

Format de retour

Format attendu

{
  "lastname": string,
  "firstname": string,
  "photo": string,
  "euid": string,
  "qrCode": {
    "type": string,
    "value": string
  },
  "errors": string[]
} 

• lastname : nom de l’utilisateur

• firstname : prénom de l’utilisateur

• photo : photo de l’utilisateur encodée en base64

• euid : numéro étudiant européen

• qrCode (nullable) : 

  • type : type d’action au scan du QRCode (image)

  • value : le QR code généré sous forme de code HTML / SVG (valeur renvoyée par défaut par l'API ESC Router)

Cas d'erreur

Codes erreurs

Liste des codes erreurs actuels concernant l’API des cartes dématérialisées :

• NO_PHOTO : l’utilisateur ne peut pas disposer d’une carte car il n’a pas fourni de photo (à la scolarité de la formation)

• NO_ACTIVE_CARD : l’utilisateur ne dispose pas de carte européenne active

• ESCN_MISSING : l'utilisateur ne dispose pas de numéro d'étudiant européen

Ces codes erreurs sont actuellement retournés avec un code HTTP 200 car il ne s’agit pas d’une erreur au sens propre de l’API mais plutôt d’une indication à l’utilisateur qu’il ne peut pas disposer d’une carte dématérialisée dans l’application mobile.

Autres erreurs

user_not_found (code 404) : L’utilisateur dont le login est passé en paramètre lors de l’appel n’a pas pu être trouvé dans le SI de l'établissement

Exemple :

{ 
	"error": "user_not_found_in_ldap",

...

 
	"error_description": "L'utilisateur or login 'bidule' n'a pas pu être trouvé dans le LDAP ou est sursitaire" 
}

Exemple

{
	"lastname": "Doe",
    "firstname": "John",
    "title": 'Etudiant',
    "subtitle": "carte d'identité",
    "euid": "fr:010203040AB",
    "photo": "data:image/jpeg;base64,/9j/4AA...",
    "qrCode": {
		"type": "image",
        "value": "<svg xmlns="http://www.w3.org/2000/svg" height="224.8" width="184.8>...</svg>"
	},
	"errors": []
}