Aller au contenu
Accueil moxon

Génération de Captcha

L'endpoint /captcha génère une image CAPTCHA. Vous pouvez fournir votre propre texte ou laisser l'API en générer un aléatoirement.

gethttps://api.moxon.dev/v4/captcha
Essayerget/v4/captcha

Paramètres

  • textstringoptionnel

    Le texte du captcha. Si omis, une chaîne aléatoire est générée

  • lengthnumberoptionnel

    Longueur du texte auto-généré (défaut 6)

  • widthnumberoptionnel

    Largeur de l'image en pixels (défaut 300)

  • heightnumberoptionnel

    Hauteur de l'image en pixels (défaut 150)

  • noise"low" | "medium" | "high"optionnel

    Nombre de lignes de bruit (défaut 5)

  • bgstringoptionnel

    Couleur de fond en hexadécimal (ex. ffffff)

  • colorstringoptionnel

    Couleur du texte en hexadécimal (ex. 000000)

Réponse

L'endpoint retourne une image PNG du captcha généré.

À savoir

La réponse inclut un header X-Captcha-Text contenant la réponse du captcha, utile pour la vérification côté serveur. Lorsqu'aucun text n'est fourni, la chaîne auto-générée évite les caractères ambigus (ex. 0/O, 1/l).

Exemples de code

Gestion des erreurs

Si les paramètres sont manquants ou invalides, l'API retournera une erreur :

  • 400length must be a numberLe paramètre length n'est pas un nombre
  • 400length must be between 1 and 20La length est hors limites
  • 400width must be a numberLe paramètre width n'est pas un nombre
  • 400width must be between 100 and 800La width est hors limites
  • 400height must be a numberLe paramètre height n'est pas un nombre
  • 400height must be between 50 and 400La height est hors limites
  • 400noise must be one of: low, medium, highValeur de noise invalide
  • 400Invalid color (use hex like ff6600)Un paramètre bg ou color est mal formaté