Créer un compte et obtenir vos clés

Toute cette documentation suppose que vous détenez une clé API. Cette page est son point d’origine. Pas d’appel commercial, pas de file de validation : l’inscription est en libre-service et vous place directement dans la Sandbox.

Inscrivez-vous

Rendez-vous sur app.cowriepay.io/signup. Le formulaire demande votre email, votre nom, et le nom de votre entreprise. Il vous demande aussi d’accepter les documents contractuels (chacun nommé avec sa version, chacun étant un lien que vous pouvez lire avant de cocher) et de confirmer que vous vous inscrivez à titre professionnel et non en tant que consommateur ; une case marketing distincte est optionnelle et jamais pré-cochée. Un écran de vérification récapitule ensuite votre saisie, et vous confirmez une seule fois.

CowriePay s’adresse aux professionnels et non aux consommateurs, et cela tient à l’usage que vous en faites, pas à votre forme juridique : un entrepreneur individuel ou un freelance régulièrement immatriculé y a autant sa place qu’une société.

Il n’y a pas de champ mot de passe, et c’est voulu : le mot de passe se définit après le clic sur le lien d’activation que nous vous envoyons par email, si bien que rien n’existe pour votre compte tant que vous n’avez pas prouvé que l’adresse est la vôtre.

Si l’email n’arrive pas au bout de quelques minutes, vérifiez vos spams, puis utilisez le lien de renvoi sur l’écran de confirmation. Ce renvoi existe pour une bonne raison ; utilisez-le plutôt que de vous réinscrire.

Activez, et sauvegardez votre clé

Le clic sur le lien d’activation vous fait définir un mot de passe, puis active votre workspace. Si vous êtes le propriétaire du workspace, l’activation émet aussi votre première clé API Sandbox (préfixe cpk_test_).

Le secret est montré une seule fois, à cet instant, et n’est jamais récupérable ensuite. Enregistrez la clé et le secret dans votre gestionnaire de secrets avant de quitter la page. Un secret perdu ne se retrouve pas : vous créez une nouvelle clé depuis le tableau de bord et révoquez l’ancienne.

La clé initiale porte exactement les scopes dont le Démarrage rapide a besoin : wallets:read et wallets:write, transactions:read, webhooks:read et webhooks:write, customers:read et customers:write. Deux familles en sont volontairement absentes :

api_keys:* : une clé capable de créer des clés rend une fuite auto-renouvelable ; la révoquer ne suffirait plus à clore une compromission. Créez vos clés depuis le tableau de bord.
withdrawals:* : le parcours de retrait porte des contrôles de sécurité (liste d’autorisation, approbation) que le flux Sandbox ne vous enseignerait pas. Voyez Passage en production pour le comportement réel des retraits.

Créez d’autres clés depuis le tableau de bord

La page Developer du tableau de bord crée des clés supplémentaires, et c’est là que vous modelez les accès :

Scopes : donnez à chaque intégration uniquement les scopes qu’elle utilise (resource:action, catalogue sur Create an API key dans la référence de l’API).
Réseau : une clé est soit Sandbox (cpk_test_), soit production (cpk_live_) ; les clés de production n’existent qu’une fois votre workspace passé en production.
Liste d’autorisation d’IP (optionnelle) : restreignez la clé aux adresses de vos serveurs.
Expiration (optionnelle) : bornez dans le temps une clé confiée à un prestataire ou à un banc de test.

La révocation est immédiate. La règle du secret unique vaut pour toutes les clés : le secret apparaît à la création, puis jamais plus.

Un compte, un workspace en libre-service

Une adresse email peut créer un workspace en libre-service. Si vous devez ensuite accéder à d’autres workspaces (une agence qui travaille pour plusieurs clients, par exemple), vous les rejoignez sur invitation, sans limite. Votre identifiant reste une seule identité pour tous, et le tableau de bord permet de changer de workspace.

Et ensuite

Démarrage rapide : un premier dépôt crédité, avec les seuls scopes de cette clé.
La sandbox et le faucet : ce qu’est vraiment la Sandbox, et comment l’alimenter.
Authentification : la recette de signature dans laquelle votre clé et votre secret s’insèrent.