Skip to content

Créer une Configuration

post
https://api.reach.talkylabs.com/rest/authentix/v1/configurations

Cette opération permet de créer une configuration Authentix.

Paramètres

  • serviceNamestringrequired

    Le nom du service d'authentification associé à cette configuration. Il peut comporter jusqu'à 40 caractères.

  • codeLengthintegeroptional

    La longueur du code à générer. Elle doit être comprise entre 4 et 10 inclusivement. Si elle n'est pas spécifiée, la valeur par défaut est 5.

  • allowCustomCodebooleanoptional

    Un indicateur permettant de savoir si la configuration doit permettre l'envoi de codes personnalisés et pre-générés. La valeur par défaut est false.

  • usedForDigitalPaymentbooleanoptional

    Indicateur permettant de savoir si la configuration est utilisée pour authentifier les paiements numériques. Dans ce cas, des informations supplémentaires telles que le montant et le bénéficiaire de la transaction financière doivent être envoyées au moment de l'authentification. La valeur par défaut est false.

  • defaultExpiryTimeintegeroptional

    Il représente la durée, en minutes, pendant laquelle un processus d'authentification restera dans le statut awaiting avant de passer à expired dans le cas où aucune correspondance valide n'est effectuée dans l'intervalle.

    Cela signifie également que le code envoyé pour l'authentification reste le même pendant sa période de validité jusqu'à ce que l'authentification soit réussie. En d'autres termes, si une autre demande d'authentification est formulée au cours de cette période, le même code sera envoyé.

    Si elle n'est pas spécifiée, la valeur par défaut est de 15 minutes. Il doit s'agir d'une valeur comprise entre 1 et 1440, ce qui représente 24 heures.

  • defaultMaxTrialsintegeroptional

    Il représente le nombre maximum d'essais d'authentification pour un processus d'authentification. La valeur par défaut est 5.

  • defaultMaxControlsintegeroptional

    Il représente le nombre maximum de contrôles de code pour un processus d'authentification. Il doit être compris entre 1 et 6 inclusivement. La valeur par défaut est 3.

  • smtpSettingIdstringoptional

    Il s'agit de l'ID des paramètres SMTP utilisés par cette configuration. Il est obligatoire pour l'envoi des codes d'authentification par courrier électronique. Une configuration SMTP peut être créée facilement via la console web.

  • emailTemplateIdstringoptional

    Il s'agit de l'ID du modèle de courrier électronique par défaut à utiliser pour l'envoi des codes d'authentification par courrier électronique. S'il n'est pas fourni, le message utilisé sera :

    ${SERVICE_NAME} : your authentication code is ${CODE}.

  • smsTemplateIdstringoptional

    Il s'agit de l'ID du modèle de SMS par défaut à utiliser pour l'envoi de codes d'authentification par SMS. S'il n'est pas fourni, le message utilisé sera :

    ${SERVICE_NAME} : your authentication code is ${CODE}.

Exemple 1: Créer une configuration Authentix

L'exemple ci-dessous montre comment créer une configuration en utilisant l'API Reach Authentix.

Il crée une configuration avec un nom de service correspondant à AuthService et une longueur de code de 6. De plus, en plus des codes générés aléatoirement, il permet l'envoi de codes personnalisés et pre-générés.

curl -X POST https://api.reach.talkylabs.com/rest/authentix/v1/configurations --data-urlencode "serviceName=AuthService" --data-urlencode "codeLength=6" --data-urlencode "allowCustomCode=true" -H "ApiUser: $REACH_TALKYLABS_API_USER" -H "ApiKey: $REACH_TALKYLABS_API_KEY"
Output example
{
  "appletId": "AIDXXXXXXXXXXXX",
  "apiVersion": "1.0.0",
  "configurationId": "CIDXXXXXXXXXXXX",
  "serviceName": "myService",
  "codeLength": 5,
  "allowCustomCode": false,
  "usedForDigitalPayment": false,
  "defaultExpiryTime": 5,
  "defaultMaxTrials": 5,
  "defaultMaxControls": 3,
  "smtpSettingId": "STPXXXXXXXXXXXXX",
  "emailTemplateId": "TMEXXXXXXXXXXXXXXX",
  "smsTemplateId": "TMSXXXXXXXXXXXXXXX",
  "dateCreated": "2016-08-29T09:12:33.001Z",
  "dateUpdated": "2016-08-29T09:12:35.001Z"
}

Exemple 2: Créer une configuration Authentix permettant l'authentification des paiement numérique

L'exemple ci-dessous montre comment créer une configuration qui permet la vérification des paiements numériques en utilisant l'API Reach Authentix.

Il crée une configuration avec un nom de service correspondant à AuthService et une longueur de code de 6. De plus, en plus des codes générés aléatoirement, il permet l'envoi de codes personnalisés.

curl -X POST https://api.reach.talkylabs.com/rest/authentix/v1/configurations --data-urlencode "serviceName=AuthService" --data-urlencode "codeLength=6" --data-urlencode "allowCustomCode=true" --data-urlencode "usedForDigitalPayment=true" -H "ApiUser: $REACH_TALKYLABS_API_USER" -H "ApiKey: $REACH_TALKYLABS_API_KEY"
Output example
{
  "appletId": "AIDXXXXXXXXXXXX",
  "apiVersion": "1.0.0",
  "configurationId": "CIDXXXXXXXXXXXX",
  "serviceName": "myService",
  "codeLength": 5,
  "allowCustomCode": false,
  "usedForDigitalPayment": false,
  "defaultExpiryTime": 5,
  "defaultMaxTrials": 5,
  "defaultMaxControls": 3,
  "smtpSettingId": "STPXXXXXXXXXXXXX",
  "emailTemplateId": "TMEXXXXXXXXXXXXXXX",
  "smsTemplateId": "TMSXXXXXXXXXXXXXXX",
  "dateCreated": "2016-08-29T09:12:33.001Z",
  "dateUpdated": "2016-08-29T09:12:35.001Z"
}