diff options
| author | Christian Grothoff <christian@grothoff.org> | 2024-02-05 22:22:29 +0100 |
|---|---|---|
| committer | Christian Grothoff <christian@grothoff.org> | 2024-02-08 16:33:08 +0100 |
| commit | cdcbf16507936e91b5649957ecaaf27032c501f6 (patch) | |
| tree | 455761a6936319d32ffcc958f6bc438a47551a24 /core/api-merchant.rst | |
| parent | b864feead778b0f6a4c23af4f1f970b50efcadfc (diff) | |
| download | docs-cdcbf16507936e91b5649957ecaaf27032c501f6.tar.gz docs-cdcbf16507936e91b5649957ecaaf27032c501f6.tar.bz2 docs-cdcbf16507936e91b5649957ecaaf27032c501f6.zip | |
document 308 redirect for deprecated /instances/default/* URLs
Diffstat (limited to 'core/api-merchant.rst')
| -rw-r--r-- | core/api-merchant.rst | 16 |
1 files changed, 9 insertions, 7 deletions
diff --git a/core/api-merchant.rst b/core/api-merchant.rst index 3582e628..652c7303 100644 --- a/core/api-merchant.rst +++ b/core/api-merchant.rst @@ -36,11 +36,13 @@ This is useful when multiple businesses want to share the same payment infrastructure. Merchant backends have one special ``default`` instance. This ``default`` -instance is used when no explicit instance is specified. Despite its name, -this instance must be created after the installation. In case *no* default -instance is found - or its credentials got lost -, the administrator can use -the default instance's rights by resorting on the ``--auth`` command line option, -or by restarting the service by providing an environment variable called +instance is used when no explicit instance is specified. Note that using +``/instances/default/$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. In case *no* default instance is +found - or its credentials got lost -, the administrator can use the default +instance's rights by resorting on the ``--auth`` command line option, or by +restarting the service by providing an environment variable called ``TALER_MERCHANT_TOKEN``. Each instance (default and others) has a base URL. The resources under @@ -74,10 +76,10 @@ Examples: https://merchant-backend.example.com/instances/myinst/orders/ABCD A private endpoint (explicit "default" instance): - https://merchant-backend.example.com/instances/default/private/orders + https://merchant-backend.example.com/private/orders A public endpoint (explicit "default" instance): - https://merchant-backend.example.com/instances/default/orders + https://merchant-backend.example.com/orders Endpoints to manage other instances (ONLY for implicit "default" instance): https://merchant-backend.example.com/management/instances |