88API88API
User GuideAI ApplicationsAPI ReferenceHelp & Support
API Module Guide

Module d'authentification de courrier électronique

Description des fonctionnalités

Le préfixe de l'interface est uniformément http(s)://<your-domain>

HTTPS doit être utilisé dans les environnements de production pour sécuriser les jetons d'authentification. HTTP n'est recommandé que pour les environnements de développement.

Implémente des fonctionnalités de vérification des e-mails et de réinitialisation du mot de passe, intégrant la limitation du débit et la protection Turnstile. Prend en charge la génération automatique de mots de passe aléatoires et la personnalisation des modèles de courrier électronique. Largement utilisé dans des scénarios tels que l'enregistrement des utilisateurs et la liaison de compte.

🔐 Aucune authentification requise

Envoyer un e-mail de vérification

  • Nom de l'interface: Envoyer un e-mail de vérification
  • Méthode HTTP: GET
  • Chemin: /api/verification
  • Exigence d'authentification: publique (tarif limité)
  • Description de la fonction: envoie un code de vérification par e-mail à l'adresse e-mail spécifiée, utilisée pour les opérations de liaison ou de vérification par e-mail.

💡 Exemple de demande:

const response = await fetch(`/api/verification?email=${email}&turnstile=${turnstileToken}`, {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json'
  }
});
const data = await response.json();

✅ Exemple de réponse réussie:

{
  "success": true,
  "message": ""
}

❗ Exemple de réponse en cas d'échec:

{
  "success": false,
  "message": "Invalid parameter"
}

🧾 Description du champ:

  • email (String) : L'adresse email recevant le code de vérification ; doit être un format de courrier électronique valide.
  • turnstile (String): jeton de vérification du tourniquet, utilisé pour empêcher les attaques de robots.

Envoyer un e-mail de réinitialisation du mot de passe

  • Nom de l'interface: Envoyer un e-mail de réinitialisation du mot de passe
  • Méthode HTTP: GET
  • Chemin: /api/reset_password
  • Exigence d'authentification: publique (tarif limité)
  • Description de la fonction: envoie un lien de réinitialisation de mot de passe à une adresse e-mail enregistrée, utilisée par les utilisateurs pour récupérer leur mot de passe.

💡 Exemple de demande:

const response = await fetch(`/api/reset_password?email=${email}&turnstile=${turnstileToken}`, {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json'
  }
});
const data = await response.json();

✅ Exemple de réponse réussie:

{
  "success": true,
  "message": ""
}

❗ Exemple de réponse en cas d'échec:

{
  "success": false,
  "message": "This email address is not registered"
}

🧾 Description du champ:

  • email (String) : L'adresse email nécessitant la réinitialisation du mot de passe ; doit être un email enregistré.
  • turnstile (String): Jeton de vérification du tourniquet, utilisé pour empêcher les requêtes malveillantes.

Soumettre une demande de réinitialisation du mot de passe

  • Nom de l'interface: Soumettre une demande de réinitialisation du mot de passe
  • Méthode HTTP: POST
  • Chemin: /api/user/reset
  • Exigence d'authentification: publique
  • Description de la fonction: termine la réinitialisation du mot de passe à l'aide du lien de réinitialisation fourni dans l'e-mail. Le système génère et renvoie un nouveau mot de passe.

💡 Exemple de demande:

const response = await fetch('/api/user/reset', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    email: "user@example.com",
    token: "verification_token_from_email"
  })
});
const data = await response.json();

✅ Exemple de réponse réussie:

{
  "success": true,
  "message": "",
  "data": "newPassword123"
}

❗ Exemple de réponse en cas d'échec:

{
  "success": false,
  "message": "The reset link is illegal or expired"
}

🧾 Description du champ:

  • email (String) : L'adresse email pour laquelle le mot de passe doit être réinitialisé.
  • token (String) : Le jeton de vérification obtenu à partir de l'e-mail de réinitialisation.
  • data (String): Le nouveau mot de passe renvoyé en cas de succès. Le système génère automatiquement un mot de passe aléatoire à 12 chiffres.