Référence API

API du portail client

Génère des URL de portail client MakePay signées pour les clients enregistrés.

Générer un lien de portail

Créez un lien vers le portail client MakePay à partir d'un profil client MakePay stocké. Générez le lien uniquement lorsque le client ou le merchant clique sur la facturation, puis redirigez ou ouvrez le URL renvoyé.

POST /api/partner/v1/makepay/customers/{customerId}/portal

customerId accepte l'UUID client stocké ou le client UID. Le corps de la requête est vide.

curl

curl -X POST "https://www.makecrypto.io/api/partner/v1/makepay/customers/CUSTOMER_ID/portal" \
  -H "x-makecrypto-key-id: MAKEPAY_API_KEY_ID" \
  -H "x-makecrypto-key-secret: MAKEPAY_API_SECRET" \
  -H "Accept: application/json"

Authentification

Les intégrations de serveur s'authentifient avec une clé MakePay API. Les sessions de navigateur peuvent appeler l'itinéraire du tableau de bord à l'échelle de l'entreprise lorsque l'utilisateur connecté a settings.manage dans l'équipe sélectionnée. Les demandes de clé API ne transmettent pas d'ID d'entreprise dans URL car la clé appartient déjà à une entreprise.

En-tête	Valeur	Notes
`x-makecrypto-key-id`	ID de clé API MakePay	Commence par `mk_makepay_` pour les API de paiement MakePay.
`x-makecrypto-key-secret`	Secret API à usage unique	Affiché uniquement lors de la création de la clé. Stockez-le dans votre gestionnaire de secrets côté serveur.

Réponse

L'itinéraire renvoie l'objet client ainsi qu'un lien urls.customerPortal signé.

json

{
  "ok": true,
  "companyId": "acct_123",
  "customer": {
    "id": "b834dd77-69b8-41a9-a4b6-95bc9dd14c2d",
    "uid": "cus_01hzy4k6p4w9y2x7e2z7n8a2xm",
    "email": "buyer@example.com",
    "name": "Ada Lovelace",
    "clientId": "client_1042",
    "metadata": {
      "source": "api"
    },
    "createdAt": "2026-04-20T10:00:00.000Z",
    "updatedAt": "2026-04-20T10:00:00.000Z",
    "urls": {
      "customerPortal": "https://makepay.io/billing?company=acct_123&customer=cus_01hzy4k6p4w9y2x7e2z7n8a2xm&expires=1776765600&signature=8d1f..."
    }
  },
  "expiresAt": "2026-04-21T10:00:00.000Z"
}

Paramètres URL signés

Le portail renvoyé URL a cette forme :

https://{makepay-or-verified-merchant-domain}/billing?company={companyId}&customer={customerUid}&expires={unixSeconds}&signature={hexHmac}

Paramètre	Remarques
`company`	ID de compte d’entreprise MakeCrypto propriétaire du client.
`customer`	Le client MakePay, UID, s'étendait à cette entreprise.
`expires`	Horodatage Unix en secondes. Les liens sont valables 24 heures.
`signature`	Signature HMAC sur les valeurs de version, d'entreprise, de client et d'expiration.

MakePay vérifie la signature et l'expiration avant de charger des données de portail. Ne stockez pas les URL du portail de manière permanente. Régénérez un nouveau lien à chaque clic de bouton.

Portée du portail

Le portail affiche uniquement les données qui correspondent à l'entreprise et au client signés :

Résumé du profil client et nom d’affichage modifiable.
Historique des paiements correspondant à l'e-mail du client ou à l'identifiant du client.
Liens de paiement actifs ou impayés avec des URL MakePay hébergées.
Abonnements correspondant à l'adresse e-mail du client ou à l'ID client de métadonnées.
Suspendez, réactivez et annulez les actions pour les états d'abonnement pris en charge.

Les e-mails, les identifiants clients, les PDF, les méthodes de paiement, les clés de licence, les changements de forfait et les flux de reprise d'abonnement annulé ne sont pas modifiables dans la première version du portail.