Skip to content

Initier une Authentification

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

Cette opération permet d'initier un nouveau processus d'authentification en envoyant un code via un canal spécifique.

Paramètres

  • configurationIdstringrequiredpath

    L'identifiant de la configuration utilisée.

  • deststringrequired

    Le numéro de téléphone ou l'adresse électronique où envoyer le code d'authentification. Les numéros de téléphone doivent être au format E.164 (https://en.wikipedia.org/wiki/E.164).

  • channelstringrequired

    Le canal par lequel le code d'authentification est envoyé. Au choix entre sms, ou email.

  • serviceNamestringoptional

    Un nom de service remplaçant celui défini dans la configuration.

  • customCodestringoptional

    Le code pré-généré à envoyer. Sa longueur doit être comprise entre 4 et 10 inclus.

  • paymentInfostringoptional

    Informations relatives au paiement numérique à authentifier. Elle est requise lorsque usedForDigitalPayment est vrai. Elle est ignorée dans le cas contraire. Il s'agit d'un objet JSON à plat où les clés sont payee, amount, et currency et les valeurs associées sont respectivement le bénéficiaire, le montant, et la devise d'une transaction financière. Par exemple "{'payee' : 'ACME', 'amount' : '1000', 'currency' : 'xaf'}".

  • templateIdstringoptional

    Il s'agit de l'identifiant du modèle de message à utiliser pour envoyer le code d'authentification. Il peut s'agir d'un modèle de SMS ou d'e-mail, en fonction du canal utilisé. Il remplace l'identifiant du modèle défini dans la configuration, le cas échéant.

  • templateDataMapstringoptional

    Un object JSON à plat dont les clés sont les paramètres du modèle de message et les valeurs sont les valeurs des paramètres à utiliser lors de l'envoi du code d'authentification. Elle peut également être utilisée pour fournir des paramètres supplémentaires pour l'envoi des codes d'authentification par courrier électronique, comme le courrier électronique utilisé pour l'envoi du code. Par exemple "{'sender_email' : 'me@my-company.com'}".

Exemple 1: Initier une authentification par SMS

L'exemple ci-dessous montre comment initier une authentification par SMS en utilisant l'API Reach Authentix.

curl -X POST https://api.reach.talkylabs.com/rest/authentix/v1/configurations/CIDXXXXXXXXXXXX/authentications --data-urlencode "dest=+237671234567" --data-urlencode "channel=sms" -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: Initier une authentification par Email

L'exemple ci-dessous montre comment initier une authentification par courrier electronique en utilisant l'API Reach Authentix.

curl -X POST https://api.reach.talkylabs.com/rest/authentix/v1/configurations/CIDXXXXXXXXXXXX/authentications --data-urlencode "dest=user@customsite.com" --data-urlencode "channel=email" -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"
}