Lorsqu'un utilisateur scanne un Ubiqod Key, la plateforme Ubiqod permet de s'assurer que ce scan est bien légitime.
2 cas sont à distinguer :
- Vous utilisez une interface créée sur la plateforme Ubiqod : la validation est effectuée automatiquement
- Vous redirigez l'utilisateur vers votre propre interface : un token est envoyé dans l'url, et sa validité peut être vérifiée via une route API
Ajout du token de validation dans l'url
Pour rediriger les utilisateurs vers votre propre interface, créez une interface de type Redirection:
Saisissez ensuite l'url de votre interface, et cochez la case Jeton de validation :
Nous vous recommandons de cocher Numéro de série du tracker afin de renforcer les vérifications (voir section Vérification de la validité du token)
L'aperçu de l'url (Exemple de redirection) vous permet de prévisualiser les paramètres qui seront ajoutés.
Si vous souhaitez changer le nom du paramètre par défaut, décochez Jeton de validation et ajoutez le paramètre à l'aide des options avancées :
Vérification de la validité du token
Appel API
Il vous appartient de récupérer le contenu du token et le numéro de série de l'Ubiqod Key émetteur à partir des paramètres de l'url redirigée.
Vous pourrez alors vérifier la validité du jeton en appelant la route GET : https://k.ubiqod.com/key/validatetoken
Comme pour un appel API standard, vous devrez passer votre clef API dans le header, dans une propriété X-API-KEY ({X-API-KEY: <<your-api-key>>})
Le token devra être passé dans le paramètre d'url token (token=<<your-token>>)
Exemple d'url complète (hors header) : https://k.ubiqod.com/key/validatetoken?token=<<your-token>>
Réponse du serveur
En cas de succès, la réponse du serveur sera de la forme (code 200) :
- {
- "tokenData": {
- "creationDate": "2021-02-04T15:10:32.157Z",
- "trackerLabel": "Test device",
- "trackerName": "UK12346"
- }
- }
Nous vous recommandons de vous assurer que le token est valide ET que le trackerName correspond bien au numéro de série de l'Ubiqod Key émetteur.
Si le token n'existe pas, la réponse sera (code 200) :
- {
- "message": "Token not found for this account"
- }
Pour des raisons de performance et de sécurité, le jeton est conservé 24h après son émission : pensez à faire cette validation à réception des données.
En cas d'invalidité de la clef API, une erreur 401 sera retournée.
Si le token n'est pas fourni, une erreur 400 sera retournée.