Aller au contenu

Clés API

Les clés API sont utilisées pour autoriser l’accès à l’API et doivent être incluses avec chaque demande. Il existe deux types de clés API :

Clés API Gratuites

Les clés API gratuites peuvent être créées sans frais, offrant un accès limité à l’API.

Conditions d’utilisation des clés API gratuites :

Génération d’une clé API gratuite

Les clés API gratuites sont liées à un nom de domaine spécifique et ne fonctionnent que sur les sites Web hébergés sur le nom de domaine fourni.

Générer une clé API gratuite
Si vous utilisez un numéro de port non standard, entrez le nom de domaine et le port dans ce format : exemple.com:3000.

Le serveur générera une nouvelle clé API gratuite et un secret :

{
"hostname": "exemple.com",
"apiKey": "ckey_49960de...",
"secret": "csec_55de16dde79f94...",
"licence": "..."
}

Le secret csec_... est utilisé pour la vérification de la charge utile (en tant que secret HMAC) et doit rester confidentiel, jamais exposé publiquement.

Consultez la documentation pour apprendre comment générer une nouvelle clé API en utilisant l’API.

Vérification de Domaine

Bien que facultative, la vérification de domaine est fortement recommandée. La vérification de la propriété de votre nom de domaine via l’enregistrement DNS TXT configuré avec la valeur fournie altcha-verification=... ajoute une couche supplémentaire de sécurité.

La vérification de domaine garantit que votre Clé API est correctement associée au nom de domaine avec lequel elle est censée fonctionner.

Pour vérifier votre nom de domaine, suivez ces étapes :

  1. Accédez à votre panel de gestion des enregistrements DNS.
  2. Ajoutez un enregistrement TXT avec les détails suivants :
    • Type d’Enregistrement : TXT
    • Hôte/Nom : @ (ou votre nom de domaine)
    • Valeur/Texte : altcha-verification=abc... (remplacez abc... par votre jeton de vérification unique obtenu lors de la génération de la Clé API)
  3. Enregistrez les modifications.

Une fois que l’enregistrement DNS est ajouté avec succès et propagé, la propriété du domaine sera vérifiée. Cela garantit l’utilisation sécurisée de votre Clé API avec le nom de domaine spécifié.

Attribution pour les clés API gratuites

Lors de l’utilisation de la clé API gratuite, vous DEVEZ afficher “Protégé par ALTCHA” avec le logo dans le widget (c’est-à-dire ne pas utiliser hidelogo ou hidefooter). Si vous n’utilisez pas le widget, vous DEVEZ inclure une attribution dans le pied de page de votre site Web, au moins sur la page d’accueil :

<a href="https://altcha.org">Protégé par ALTCHA</a>

Vous pouvez traduire ou modifier le texte, mais il doit transmettre un sens similaire à “Protégé par ALTCHA”. Le lien doit diriger vers https://altcha.org et ne doit pas inclure rel="nofollow".

Clés d’API Payantes

Les plans payants pour l’API sont disponibles dans l’application Forms. Tous les plans SaaS donnent accès à la fois à l’API de Filtre Anti-Spam et aux Formulaires. Alternativement, vous pouvez opter pour des plans AntiSpam Seulement, qui offrent un accès à l’API sans les Formulaires.

Pour obtenir un accès payant à l’API, suivez ces étapes :

  1. Inscrivez-vous pour un nouveau compte sur ALTCHA Forms sur eu.altcha.org pour les clients de l’UE, ou us.altcha.org pour les clients américains.
  2. Dans l’application, accédez à Paramètres du compte -> Facturation et sélectionnez le plan souhaité.
  3. Complétez le processus de paiement.
  4. Générez une nouvelle clé API dans Paramètres du compte -> Clés API.