Codex · III

Clés API

Les clés API vous permettent d'appeler les endpoints de paiement et de statut à partir de votre propre code, sans le bouton d'achat. Vous n'en avez besoin que si vous construisez votre propre paiement ou intégration serveur ; si vous collez le bouton d'achat, vous pouvez sauter cela entièrement.

Quand vous avez besoin d'une clé

Le bouton d'achat fonctionne sans aucune clé — il parle aux endpoints publics et orientés projet. Une clé est pour l'autre chemin : les appels que vous faites à partir de votre propre serveur, où vous créez un paiement ou lisez le statut d'une transaction dans le code. Les clés vivent sous l'onglet Clés API de votre projet.

L'onglet Clés API. Vide jusqu'à ce que vous créiez votre première clé.

Créer une clé

Cliquez sur Créer clé, donnez-lui un nom que vous reconnaîtrez plus tard — généralement où elle s'exécute, comme « Serveur de production » — et cliquez sur Générer clé. Le nom n'est qu'une étiquette pour vous ; il ne change pas ce que la clé peut faire (une clé est orientée à ce projet).

Nommez la clé pour où elle vivra, puis générez-la.

Copiez-la une fois

La clé est affichée une fois, juste après sa génération. Elle commence par cmk_. Copiez-la maintenant et stockez-la quelque part de sûr — nous ne conservons qu'un hash, nous ne pouvons donc pas vous la montrer à nouveau. Perdez-la et vous créez simplement une nouvelle et supprimez l'ancienne.

C'est la seule fois que la clé complète est affichée. Copiez-la avant de fermer.

Traitez la clé comme un mot de passe. Utilisez-la uniquement à partir du code côté serveur, envoyez-la dans l'en-tête Authorization en tant que jeton porteur, et ne la mettez jamais sur une page web, un référentiel public ou quoi que ce soit qui s'expédie au navigateur d'un acheteur. Quiconque a la clé peut agir pour votre projet.

Utiliser, lister et révoquer

Les clés enregistrées sont listées par nom, un préfixe masqué et la date de création. Vous ne voyez jamais la clé complète à nouveau — le préfixe est juste assez pour les distinguer. L'icône de corbeille révoque une clé immédiatement : tout code qui l'utilise toujours commence à être rejeté, donc faites tourner en créant d'abord la nouvelle clé, en la déployant, puis en supprimant l'ancienne.

Chaque clé affiche un préfixe masqué et une date de création ; l'icône de corbeille la révoque.

Pour ce que vous pouvez appeler avec la clé — créer un paiement à partir de votre propre code, gérer les événements et sonder le statut — voir Utilisation de l'API.

Prêt à le brancher ?

Le palier gratuit couvre la plupart des sites et ne demande jamais de carte.