Skip to content

Mettre à jour une Configuration

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

Cette opération permet de mettre à jour les attributs d'une configuration.

Paramètres

  • configurationIdstringrequiredpath

    L'identifiant de la configuration à mettre à jour.

  • serviceNamestringoptional

    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.

  • allowCustomCodebooleanoptional

    Un indicateur permettant de savoir si la configuration doit permettre l'envoi de codes personnalisés et pre-générés.

  • 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.

  • 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. La valeur doit être 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.

  • 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.

  • 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.

  • 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.

  • smsTemplateIdstringoptional

    Il s'agit de l'ID du modèle de SMS par défaut à utiliser pour l'envoi des codes d'authentification par SMS.

Exemple 1: Mettre à jour une configuration

L'exemple ci-dessous montre comment mettre à jour une configuration dont l'attribut configurationId est CIDXXXXXXXXXX en utilisant l'API Reach Authentix.

Dans cet exemple, la longueur du code est mise à jour à la valeur 7.

curl -X POST https://api.reach.talkylabs.com/rest/authentix/v1/configurations/CIDXXXXXXXXXXXX --data-urlencode "codeLength=7" -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"
}