Obtenez votre clé API
Connectez-vous à la plateforme développeur Cosmos Pay, choisissez un environnement et générez une clé API avec les portées dont votre intégration a besoin.
Chaque requête vers Cosmos Pay est authentifiée par une clé API. Vous créez et gérez les clés dans le tableau de bord développeur. Une clé porte deux choses importantes : l'environnement auquel elle appartient (qui détermine testnet ou mainnet, sur tous les réseaux) et les portées qu'elle est autorisée à utiliser.
Créer une clé
- Connectez-vous à la plateforme développeur sur dev.cosmospay.lat et ouvrez le Tableau de bord.
- Choisissez l'environnement avec le commutateur Test / Production du tableau de bord :
- Test délivre des clés
dv_…qui s'exécutent sur le testnet ; utilisez-les pendant le développement. - Production délivre des clés
prod_…qui s'exécutent sur le mainnet ; utilisez-les pour passer en production.
- Test délivre des clés
- Allez dans API Keys → Create.
- Donnez à la clé un nom (et une description facultative) pour pouvoir la reconnaître plus tard.
- Choisissez un rôle :
- User : limité. Sélectionnez exactement les permissions dont elle a besoin dans la matrice (par ressource : lecture et/ou écriture pour les paiements, webhooks, produits, clients et analyses).
- Admin : accès complet ; il contourne la matrice de portées. À utiliser avec parcimonie.
- Créez, puis copiez la clé immédiatement.
Affichée une seule fois
La clé complète est affichée une seule fois, à la création (et à nouveau seulement si vous la faites tourner). Stockez-la dans un gestionnaire de secrets ou les variables d'environnement de votre serveur dès maintenant, car vous ne pourrez plus la consulter.
Utiliser la clé
Gardez la clé sur votre serveur et transmettez-la au SDK (ou envoyez-la comme jeton Bearer à l'API REST) :
import { Client } from '@cosmosapp/pay_sdk';
// Reads e.g. COSMOS_PAY_API_KEY from your server environment; never hard-code it.
const client = new Client({ apiKey: process.env.COSMOS_PAY_API_KEY });Authorization: Bearer dv_xxxxxxxxxxxxxxxxxxxxxxxxMoindre privilège
Ne donnez à chaque clé que les portées dont elle a besoin. Un serveur qui ne fait que créer des paiements peut utiliser une clé avec
payments:write et payments:read et rien d'autre : ainsi, une clé divulguée ne peut pas faire plus que son rôle.
Bonnes pratiques
- Une clé par environnement / service. Ne réutilisez pas une clé
prod_en test, et faites tourner les clés par service afin de pouvoir en révoquer une sans interrompre le reste. - N'envoyez jamais une clé au navigateur. Le client web signe les transactions avec le portefeuille de l'utilisateur et n'a pas besoin de votre clé.
- Faites tourner en cas d'exposition. Si une clé fuite, faites-la tourner dans le tableau de bord : l'ancienne valeur cesse de fonctionner immédiatement.
Étapes suivantes
Pour commencer
Tout ce dont vous avez besoin avant votre premier paiement Cosmos Pay, à savoir ce que c'est, comment se déroule un paiement et les deux façons d'intégrer.
Bouton de paiement et checkout intégré
Encaissez sur votre propre site avec une seule balise script, au moyen d'un bouton qui ouvre le checkout hébergé ou d'un checkout compact dessiné dans votre page.