L'implémentation AppliExtRestWs de AppliExtApi correspond à un client Web Service REST envoyant des requêtes de badgeage à un Web Service REST.
Pour intégrer le badgeage de cartes dans une de vos applications (application de ), vous devez donc proposer l'implémentation de ce Web Service.
Cette implémentation peut se faire dans le langage de votre choix, pour réaliser cette documentation nous nous basons ici sur une implémentation réalisée en Java.
tagIdCheck
La fonction tagIdChek à pour but de retourver l'identifiant (login ou eppn) d'un individu en fonction de son numéro de carte (csn ou identifiant desfire).
Pour ce faire il faut implémenter une fonction ou un webservice qui accepte en entrée csn et/ou desfire et qui retourne un objet « TagLog » contenant à minima :
@JsonIgnoreProperties(ignoreUnknown=true)
public class TagLog {
String csn;
String eppn;
String lastname;
String firstname;
String location;
}
getLocations
La fonction getLocations retourne la liste des lieux disponibles pour l'utilisateur connecté à l'application mobile (ex : pour la carte culture le nom d'une salle de spectacle…)
La fonction prend en entrée l'identifiant de l'utilisateur (eppn) et retourne une liste de String des salles gérées par l'utilisateur.
isTagable
La fonction isTagable doit permettre de déterminer si un badge est valide pour le lieu donné. Elle prend doit prendre en entrée un objet « Taglog » contenant au moins eppn et location.
La fonction retourne une entête http tel que :
HttpStatus.OK (200) si l'individu est autorisé à badgé
HttpStatus.INTERNAL_SERVER_ERROR (500), accompagné d'un message dans le corps de la réponse si l'individu n'est pas autorisé
ex :
return new ResponseEntity<String>("OK", responseHeaders, HttpStatus.OK);
return new ResponseEntity<String>("Carte invalide", responseHeaders, HttpStatus.INTERNAL_SERVER_ERROR);
validateTag
Cette fonction valide le badgeages et déclenche un traitement metier. lle prend doit prendre en entrée un objet « Taglog » contenant au moins eppn et location. Elle retourne un statut http 200 si le traitement c'est bien déroulé ou une erreur http 500 dans le cas contraire.