L'objet ConfigurationItem
Un objet ConfigurationItem représente une configuration Authentix et correspond à un ensemble de paramètres utilisés pour définir et envoyer un code d'authentification à un utilisateur. Cela inclut par exemple la longueur du code, le nom du service, le modèle de message, les paramètres SMTP, ...
Modèles de messages
L'API Reach Authentix permet de personnaliser le message envoyé à l'utilisateur à des fins d'authentification. Les modèles de messages sont des messages prédéfinis qui servent cet objectif. Ils peuvent être définis à la fois pour les canaux sms et email via la console web.
Lors de la définition d'un modèle de message, il est possible d'introduire des variables de modèle dont les valeurs seront fournies ultérieurement lors de l'authentification afin de personnaliser le message.
Les variables de modèle se présentent sous la forme de ${VARIABLE_NAME}. Ici, VARIABLE_NAME représente le nom de la variable. Il doit être alphanumérique, insensible à la casse et doit commencer par une lettre.
Il existe des variables prédéfinies qui peuvent être utilisées dans les modèles de message avec une signification particulière:
${SERVICE_NAME} : Il correspond au nom du service associé à la configuration utilisée pour effectuer l'authentification.
${CODE} : Il correspond au code à usage unique généré et envoyé à l'utilisateur. Il doit faire partie de tous les modèles de message.
${EXPIRY_TIME} : Il correspond au délai d'expiration du code à usage unique en minutes.
${PAYEE} : Il correspond au bénéficiaire de la transaction financière. Il est nécessaire pour les authentifications des paiements numériques.
${AMOUNT} : Il correspond au montant de la transaction financière authentifiée. Il est requis pour les authentifications des paiements numériques.
${CURRENCY} : Elle correspond à la devise de la transaction financière authentifiée. Il est nécessaire pour les authentifications des paiements numériques.
En outre, il existe des variables liées au courrier électronique qui peuvent être utilisées pour personnaliser votre message :
${SENDER_EMAIL} : L'adresse électronique utilisée pour envoyer le message. S'il n'est pas spécifié, le nom d'utilisateur du paramètre SMTP sera utilisé.
${SENDER_NAME} : Le nom de l'expéditeur.
${EMAIL_SUBJECT} : L'objet du message. La valeur par défaut est : "Your authentication code".
Si aucun modèle de message n'est spécifié au cours d'une procédure d'authentification, la valeur par défaut suivante est utilisée :
En cas de vérification d'un paiement numérique :
${SERVICE_NAME}: your authentication code for the payment of ${CURRENCY} ${AMOUNT} to ${PAYEE} is ${CODE}.Sinon:
${SERVICE_NAME}: your authentication code is ${CODE}.
Paramètres SMTP
L'API Reach Authentix permet d'envoyer les codes d'authentification par courrier électronique. Pour exploiter ce canal, vous devez fournir les paramètres SMTP qui seront utilisés à cette fin. Cela inclut les paramètres telles que le serveur SMTP, le port, le nom d'utilisateur, le mot de passe, et ainsi de suite ...
Pour un guide étape par étape sur la façon d'ajouter des paramètres SMTP dans la console web, voir ici.
Attributs de ConfigurationItem
appletIdstring
L'identifiant de l'applet ayant créé la configuration.
apiVersionstring
La version de l'API utilisé lors de la création de la configuration.
configurationIdstring
L'identifiant de la configuration
serviceNamestring
Le nom du service d'authentification.
codeLengthinteger
La longueur des codes à générer.
allowCustomCodeboolean
Un indicateur permettant de savoir si la configuration permet l'envoi de codes personnalisés et pré-générés.
usedForDigitalPaymentboolean
Un indicateur permettant de savoir si la configuration est utilisée pour authentifier les paiements numériques.
defaultExpiryTimeinteger
Le délai d'expiration par défaut du code d'authentification.
defaultMaxTrialsinteger
Nombre maximal par défaut d'essais d'authentification pour un processus d'authentification.
defaultMaxControlsinteger
Nombre maximal par défaut de contrôles de code pour un processus d'authentification.
smtpSettingIdstring
L'ID des paramètres SMTP utilisés par la configuration.
emailTemplateIdstring
L'ID du modèle de courrier electronique par défaut utilisé par cette configuration.
smsTemplateIdstring
L'ID du modèle sms par défaut utilisé par cette configuration.
dateCreateddate-time
La date et l'heure (UTC) auxquelles la configuration a été créé.
dateUpdateddate-time
La date et l'heure (UTC) de la dernière mise à jour de la configuration.