Skip to content

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.

Paramètres

ParamètreRequisDescription
textNonLe texte du captcha. Si omis, une chaîne aléatoire est générée
lengthNonLongueur du texte auto-généré (défaut 6)
widthNonLargeur de l'image en pixels (défaut 300)
heightNonHauteur de l'image en pixels (défaut 150)
noiseNonNombre de lignes de bruit (défaut 5)
bgNonCouleur de fond en hexadécimal (ex. ffffff)
colorNonCouleur 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

curl -X GET \
  "https://api.sylvain.sh/v4/captcha?length=8&width=400&noise=high&bg=f0f0f0"

Essayer

Gestion des erreurs

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

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