Skip to content

Mettre à jour une Authentification

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

Cette opération permet de mettre à jour manuellement le statut d'une authentification. Elle ne doit être utilisée que pour les authentifications par codes personnalisés et pre-générés.

Fixez l'état de l'authentification à passed après avoir validé le code d'authentification. De même, fixez l'état de l'authentification à canceled si vous souhaitez relancer une nouvelle authentification avec un code différent.

Si vous n'utilisez pas de codes personnalisés, il n'est pas nécessaire d'utiliser cette méthode car l'API Reach Authentix peut gérer l'ensemble du cycle de vie d'une authentification.

Paramètres

  • configurationIdstringrequiredpath

    L'identifiant de la configuration utilisée.

  • authenticationIdstringrequiredpath

    L'identifiant de l'authentification à mettre à jour.

  • statusstringrequired

    Le nouveau statut de l'authentification. Au choix entre passed, ou canceled.

Exemple 1: Validation manuelle d'une authentification

L'exemple ci-dessous montre comment valider manuellement une authentification à l'aide de l'API Reach Authentix.

curl -X POST https://api.reach.talkylabs.com/rest/authentix/v1/configurations/CIDXXXXXXXXXXXX/authentications/VIDXXXXXXXXXXXX --data-urlencode "status=passed" -H "ApiUser: $REACH_TALKYLABS_API_USER" -H "ApiKey: $REACH_TALKYLABS_API_KEY"
Output example
{
  "appletId": "AIDXXXXXXXXXXXX",
  "apiVersion": "1.0.0",
  "configurationId": "CIDXXXXXXXXXXXX",
  "authenticationId": "VIDXXXXXXXXXXXX",
  "status": "awaiting",
  "dest": "+237671234567",
  "channel": "sms",
  "expiryTime": 5,
  "maxTrials": 5,
  "maxControls": 3,
  "paymentInfo": {
    "payee": "ACME",
    "amount": 1000,
    "currency": "xaf"
  },
  "trials": [
    {
      "dateCreated": "2016-08-29T09:12:33.001Z",
      "trialId": "TRDXXXXXXXXXX",
      "channel": "sms"
    }
  ],
  "dateCreated": "2016-08-29T09:12:33.001Z",
  "dateUpdated": "2016-08-29T09:12:35.001Z"
}

Exemple 2: Annuler manuellement une authentification

L'exemple ci-dessous montre comment annuler manuellement une authentification en utilisant l'API Reach Authentix.

curl -X POST https://api.reach.talkylabs.com/rest/authentix/v1/configurations/CIDXXXXXXXXXXXX/authentications/VIDXXXXXXXXXXXX --data-urlencode "status=canceled" -H "ApiUser: $REACH_TALKYLABS_API_USER" -H "ApiKey: $REACH_TALKYLABS_API_KEY"
Output example
{
  "appletId": "AIDXXXXXXXXXXXX",
  "apiVersion": "1.0.0",
  "configurationId": "CIDXXXXXXXXXXXX",
  "authenticationId": "VIDXXXXXXXXXXXX",
  "status": "awaiting",
  "dest": "+237671234567",
  "channel": "sms",
  "expiryTime": 5,
  "maxTrials": 5,
  "maxControls": 3,
  "paymentInfo": {
    "payee": "ACME",
    "amount": 1000,
    "currency": "xaf"
  },
  "trials": [
    {
      "dateCreated": "2016-08-29T09:12:33.001Z",
      "trialId": "TRDXXXXXXXXXX",
      "channel": "sms"
    }
  ],
  "dateCreated": "2016-08-29T09:12:33.001Z",
  "dateUpdated": "2016-08-29T09:12:35.001Z"
}