commit 21a642316f6bf7a0b9faaec408b2929359757922
parent 5a363440022ce913ba40987ea7062ea24aa8a100
Author: Martin Schanzenbach <schanzen@gnunet.org>
Date: Mon, 23 Jun 2025 14:31:53 +0200
default -> admin
Diffstat:
1 file changed, 10 insertions(+), 10 deletions(-)
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
@@ -33,13 +33,13 @@ A single merchant backend installation can host multiple merchant instances.
This is useful when multiple businesses want to share the same payment
infrastructure.
-Merchant backends have one special ``default`` instance. This ``default``
+Merchant backends have one special ``admin`` instance. This ``admin``
instance is used when no explicit instance is specified. Note that using
-``/instances/default/$ANYTHING`` is deprecated and will result in a permanent
+``/instances/admin/$ANYTHING`` is deprecated and will result in a permanent
redirect (HTTP status 308) to ``$ANYTHING``. a Despite its name, this instance
must be created after the installation.
-Each instance (default and others) has a base URL. The resources under
+Each instance (admin and others) has a base URL. The resources under
this base URL are divided into to categories:
* Public endpoints that are exposed to the Internet
@@ -48,19 +48,19 @@ this base URL are divided into to categories:
Internet.
* Management endpoints (under ``/management/*``) are also private and dedicated
to CRUD operation over instances and reset authentication settings over all
- instances. Only accessible with the default instance authentication token
+ instances. Only accessible with the admin instance authentication token.
Examples:
.. code-block:: none
- Base URL of the merchant (default instance) at merchant-backend.example.com:
+ Base URL of the merchant (admin instance) at merchant-backend.example.com:
https://merchant-backend.example.com/
- A private endpoint (default instance):
+ A private endpoint (admin instance):
https://merchant-backend.example.com/private/orders
- A public endpoint (default instance and order id "ABCD"):
+ A public endpoint (admin instance and order id "ABCD"):
https://merchant-backend.example.com/orders/ABCD
A private endpoint ("myinst" instance):
@@ -69,13 +69,13 @@ Examples:
A public endpoint ("myinst" instance and order id "ABCD"):
https://merchant-backend.example.com/instances/myinst/orders/ABCD
- A private endpoint (explicit "default" instance):
+ A private endpoint (explicit "admin" instance):
https://merchant-backend.example.com/private/orders
- A public endpoint (explicit "default" instance):
+ A public endpoint (explicit "admin" instance):
https://merchant-backend.example.com/orders
- Endpoints to manage other instances (ONLY for implicit "default" instance):
+ Endpoints to manage other instances (ONLY for implicit "admin" instance):
https://merchant-backend.example.com/management/instances
https://merchant-backend.example.com/management/instances/$ID