Last modified: 2024-02-16

API REST

Pour télécharger l'exemple complet de code, consultez notre site Partage de code. Pour savoir comment réinitialiser le mot de passe d'un expéditeur à l'aide de l'application, consultez Gestion des expéditeurs. Pour plus d'informations sur les paramètres de mot de passe par défaut, voir Paramètres de sécurité.

Si un utilisateur de compte oublie son mot de passe, le gestionnaire de compte peut envoyer un courriel de réinitialisation du mot de passe à l'adresse courriel du membre.

Le code

Pour envoyer le courriel de réinitialisation du mot de passe, vous devez effectuer les opérations suivantes :

  • Trouvez l'ID de l'expéditeur pour l'utilisateur.
  • Envoyez le courriel de réinitialisation du mot de passe.

Trouver l'ID de l'expéditeur

Vous pouvez rechercher l'ID d'expéditeur d'un utilisateur en utilisant la requête API suivante. La recherche s'effectue à partir du prénom, du nom ou de l'adresse courriel de l'utilisateur.

Requête HTTP

GET /api/account/senders?from=1&to=100&search={fisrtName/lastName/Email}

En-têtes HTTP

Accept: application/json
Content-Type: application/json
Authorization: Basic api_key

Données utiles de la réponse

{
  "results": [
    {
      "address": null,
      "company": "your_compnay_name",
      "timezoneId": "EST",
      "created": "2019-07-30T15:52:49Z",
      "email": "[email protected]",
      "external": null,
      "firstName": "Mary",
      "language": "en",
      "lastName": "Doe",
      "phone": "",
      "professionalIdentityFields": [],
      "signature": null,
      "title": null,
      "updated": "2019-07-30T15:52:49Z",
      "userCustomFields": [],
      "specialTypes": [],
      "passwordTimestamp": null,
      "id": "IkV7ykSic6EU",
      "status": "ACTIVE",
      "locked": null,
      "memberships": [],
      "activated": null,
      "account": {...},
      "name": "",
      "type": "REGULAR",
      "data": {...},
      "hasDelegates": false
    }
  ],
  "count": 1
}

Le paramètre « search » est utilisé pour filtrer les résultats de la recherche. Seuls les utilisateurs dont le prénom, le nom ou l'adresse courriel correspondent à cette chaîne seront répertoriés. Une recherche par caractères génériques sera effectuée par défaut. Par exemple, si vous recherchez "@example.com", vous obtiendrez tous les expéditeurs ayant ce domaine de messagerie. L'attribut « id » est celui que vous devez récupérer dans les données utiles de la réponse.

Envoi du courriel de réinitialisation du mot de passe

Après avoir récupéré l'ID d'expéditeur de votre utilisateur, vous pouvez lui envoyer un courriel pour réinitialiser son mot de passe en utilisant la requête API suivante.

Requête HTTP

POST /api/account/senders/{senderId}/resetpassword

En-têtes HTTP

Accept: application/json
Content-Type: application/json
Authorization: Basic api_key

Résultats

Après avoir exécuté votre code, votre expéditeur recevra un courriel contenant des instructions sur la façon de réinitialiser son mot de passe.

Was this information helpful?
X