Instance name

L'instance est l'identifiant technique du marchand dans FlowAlp Pay. Elle est utilisée dans le domaine de la page de paiement et dans les requêtes à la Merchant API.

Concepts essentiels

Ne confondez pas l'instance avec :

Identifiant | Signification
Instance name | Nom technique du marchand FlowAlp Pay (cet article)
FlowAlp Organization ID | Identifiant d'organisation dans le FlowAlp Dashboard
User ID | Compte utilisateur
Gateway ID | ID d'un Gateway de paiement
Transaction ID | ID d'une transaction unique
API Secret | Identifiant d'authentification (voir Identifiants API)

Format de domaine

# text
Instance:
demo-shop

Payment page:
https://demo-shop.pay.flowalp.com

API request:
https://api.pay.flowalp.com/v1.16/Gateway/?instance=demo-shop

Format général :

# text
https://<instance>.pay.flowalp.com

Utilisation dans la Merchant API

Le paramètre instance est obligatoire sur les requêtes et doit être passé en paramètre de requête.

Exemple d'URL de base :

# text
https://api.pay.flowalp.com/v1.16/:object/:id?instance=<instance>

Où :

Élément | Description
`:object` | Ressource (par exemple `Gateway`, `Transaction`, `Subscription`)
`:id` | Utilisé pour GET, PUT et DELETE sur une entité unique
`instance` | Nom de l'instance marchand

Pour les requêtes POST, tous les paramètres de requête sauf instance doivent être dans le body.

Exemple

# bash
curl --request GET \
  --url "https://api.pay.flowalp.com/v1.16/SignatureCheck/?instance=demo-shop" \
  --header "X-API-KEY: <api-secret>"

TODO FlowAlp: confirm whether SignatureCheck is the recommended smoke-test endpoint for credentials in the current version before publication.

Sécurité

• N'exposez pas l'instance avec l'API Secret dans le frontend.
• L'instance seule n'authentifie pas : sans API Secret (ou ApiSignature), les requêtes échouent.
• Vous pouvez journaliser l'instance dans les logs applicatifs ; ne journalisez jamais l'API Secret.

Étapes suivantes

• Identifiants API
• Authentification
• Première requête API