Instance name

Die Instance ist der technische Händler-Identifier innerhalb von FlowAlp Pay. Sie wird in der Domain der Zahlungsseite und in Anfragen an die Merchant API verwendet.

Kernkonzepte

Verwechseln Sie die Instance nicht mit:

Identifier | Bedeutung
Instance name | Technischer Händlername von FlowAlp Pay (dieser Artikel)
FlowAlp Organization ID | Organisations-Identifier in der FlowAlp Dashboard
User ID | Benutzerkonto
Gateway ID | ID eines Zahlungs-Gateways
Transaction ID | ID einer einzelnen Transaktion
API Secret | Authentifizierungs-Zugangsdaten (siehe API-Zugangsdaten)

Domain-Format

# 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

Allgemeines Format:

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

Verwendung in der Merchant API

Der Parameter instance ist bei Anfragen erforderlich und muss als Query-Parameter übergeben werden.

Beispiel für die Base-URL:

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

Dabei:

Teil | Beschreibung
`:object` | Ressource (zum Beispiel `Gateway`, `Transaction`, `Subscription`)
`:id` | Für GET, PUT und DELETE einer einzelnen Entität
`instance` | Name der Händler-Instance

Bei POST-Anfragen müssen alle Query-Parameter außer instance im Body stehen.

Beispiel

# 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.

Sicherheit

• Geben Sie die Instance nicht zusammen mit dem API Secret im Frontend preis.
• Die Instance allein authentifiziert nicht: ohne API Secret (oder ApiSignature) schlagen Anfragen fehl.
• Sie dürfen die Instance in Anwendungsprotokollen loggen; nie das API Secret.

Nächste Schritte

• API-Zugangsdaten
• Authentifizierung
• Erste API-Anfrage