Clés d'APIBientôt disponible

Une clé d'API permet à votre propre code d'agir sur votre propre compte Matchai. C'est la façon la plus simple d'accéder à l'API : aucune application à enregistrer, aucun flux de connexion, un seul en-tête dans chaque requête.

Utilisez une clé pour vos propres scripts et vos propres outils IA. Si vous bâtissez quelque chose que d'autres professionnels utiliseront, utilisez plutôt Se connecter avec Matchai. Consultez Les clés servent à votre propre compte.

Ce qu'est une cléCopier le lien de cette section

• Elle atteint exactement un compte : celui qui l'a créée.
• Elle porte les portées que vous avez choisies quand vous l'avez créée, et rien d'autre. Une clé avec listings:read ne peut pas modifier une inscription.
• Elle peut être révoquée en tout temps, par vous, depuis Matchai.
• Elle appartient à la connexion Accès à l'API de votre compte. L'Accès à l'API est un connecteur Matchai, comme Claude ou ChatGPT, et apparaît sur la page Connecteurs. C'est une seule connexion, peu importe le nombre de clés que vous créez, et les clés ne sont jamais facturées une à une. La page Connecteurs indique ce que coûte la connexion.

Créer une cléCopier le lien de cette section

Format des clésCopier le lien de cette section

Une clé est formée de matchai_ suivi d'une longue chaîne aléatoire de lettres et de chiffres. La partie aléatoire ne contient ni tirets ni traits de soulignement, alors un double-clic sélectionne toute la clé et un seul motif permet de la trouver :

matchai_[A-Za-z0-9]+

Traitez une clé comme une chaîne opaque. Ne l'analysez pas, et ne vous fiez pas à sa longueur. Le préfixe matchai_ est propre à Matchai, ce qui permet aux outils de détection de secrets de reconnaître une clé qui se retrouve dans un dépôt.

Utiliser une cléCopier le lien de cette section

Envoyez la clé comme jeton de porteur dans chaque requête :

curl https://api.matchai.co/v1/me \
  -H "Authorization: Bearer $MATCHAI_API_KEY"

Une requête qui ne porte aucune clé, ou une clé révoquée ou mal saisie, reçoit la réponse 401.

Protéger une cléCopier le lien de cette section

• Gardez-la sur un serveur que vous contrôlez. Lisez-la depuis une variable d'environnement ou un gestionnaire de secrets. Ne la mettez jamais dans du code exécuté dans un navigateur, une application mobile, un dépôt public, une ligne de journal ou un message de clavardage : quiconque peut la lire peut agir en votre nom.
• Utilisez une clé par script ou par environnement. Une clé distincte pour le développement et pour la production vous permet d'en révoquer une sans arrêter l'autre.
• Donnez à chaque clé le moins de portées possible. Un script qui ne fait que lire des inscriptions n'a aucun besoin de contacts:write.
• Révoquez une clé dès que vous avez un doute. Une nouvelle clé ne coûte rien. Consultez Révoquer une clé.

Renouveler une cléCopier le lien de cette section

Renouvelez vos clés selon un calendrier que vous pouvez respecter, et tout de suite si une clé a pu être vue. Plusieurs clés fonctionnent en même temps, alors le renouvellement ne demande aucune interruption de service :

Toutes les clés d'un même compte partagent sa connexion Accès à l'API, alors elles partagent aussi la limite de débit et la limite d'énergie de la connexion.

Révoquer une cléCopier le lien de cette section

Ouvrez Paramètres → Connecteurs → Options avancées (pour les développeurs) → Clés d'API et révoquez la clé. À partir de ce moment, les requêtes qui l'utilisent reçoivent la réponse 401.

Pour arrêter toutes les clés d'un coup, déconnectez Accès à l'API sur la page Connecteurs. Une connexion qui prend fin arrête toutes ses clés.

Les clés servent à votre propre compteCopier le lien de cette section

Une clé personnelle sert à votre propre compte. Les conditions d'utilisation de Matchai ne vous permettent pas d'utiliser des clés personnelles pour exploiter un service pour d'autres personnes.

Si d'autres professionnels utiliseront ce que vous bâtissez, comme un créateur de sites Web, un CRM ou un assistant IA, créez une application Matchai et utilisez Se connecter avec Matchai. Chaque professionnel voit alors ce que votre application peut faire et qui paie, donne son accord en appuyant une seule fois sur Autoriser, et peut déconnecter l'application quand il le veut. C'est aussi ce qui garantit que ses données restent les siennes.

Actions finalesCopier le lien de cette section

L'Accès à l'API a le même réglage pour les actions finales que toute autre connexion, et il commence sur Me demander. Un script qui envoie un message, publie une inscription ou supprime quelque chose reçoit 202 Accepted et attend que vous approuviez l'action dans Matchai. Écrivez vos scripts pour qu'ils gèrent les deux réponses : la section Actions finales montre comment.

Erreurs possiblesCopier le lien de cette section

La page Erreurs couvre chaque code.