summaryrefslogtreecommitdiff
path: root/core/api-merchant.rst
diff options
context:
space:
mode:
authorSebastian <sebasjm@gmail.com>2021-08-06 10:54:23 -0300
committerSebastian <sebasjm@gmail.com>2021-08-06 10:55:00 -0300
commit5370cdc8f37087dc82d4a71d4228563bcb90b95a (patch)
tree037120a0e0a9dddb47fc5d3a48c961d603fdf3fd /core/api-merchant.rst
parent5293c62b066d8106816d2f270876e21056363782 (diff)
downloaddocs-5370cdc8f37087dc82d4a71d4228563bcb90b95a.tar.gz
docs-5370cdc8f37087dc82d4a71d4228563bcb90b95a.tar.bz2
docs-5370cdc8f37087dc82d4a71d4228563bcb90b95a.zip
issue #6945: refactoring docs for management api on merchant backend service
Diffstat (limited to 'core/api-merchant.rst')
-rw-r--r--core/api-merchant.rst30
1 files changed, 15 insertions, 15 deletions
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
index 8b9d44b..5395fe1 100644
--- a/core/api-merchant.rst
+++ b/core/api-merchant.rst
@@ -48,9 +48,9 @@ this base URL are divided into to categories:
* Private endpoints (under ``/private/*``) that are only supposed to be exposed
to the merchant internally, and must not be exposed on the
Internet.
-
-To manage instances, private endpoints only available to the ``default``
-instance must be used.
+* 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
Examples:
@@ -62,14 +62,14 @@ Examples:
A private endpoint (default instance):
https://merchant-backend.example.com/private/orders
- A public endpoint (default instance):
- https://merchant-backend.example.com/orders
+ A public endpoint (default instance and order id "ABCD"):
+ https://merchant-backend.example.com/orders/ABCD
A private endpoint ("myinst" instance):
https://merchant-backend.example.com/instances/myinst/private/orders
- A public endpoint ("myinst" instance):
- https://merchant-backend.example.com/instances/myinst/orders
+ A public endpoint ("myinst" instance and order id "ABCD"):
+ https://merchant-backend.example.com/instances/myinst/orders/ABCD
A private endpoint (explicit "default" instance):
https://merchant-backend.example.com/instances/default/private/orders
@@ -78,8 +78,8 @@ Examples:
https://merchant-backend.example.com/instances/default/orders
Endpoints to manage other instances (ONLY for implicit "default" instance):
- https://merchant-backend.example.com/private/instances
- https://merchant-backend.example.com/private/instances/$ID
+ https://merchant-backend.example.com/management/instances
+ https://merchant-backend.example.com/management/instances/$ID
Endpoints to manage own instance:
https://merchant-backend.example.com/private
@@ -855,7 +855,7 @@ instance setup before it can be used to manage inventory or process payments.
Setting up instances
--------------------
-.. http:post:: [/instances/$INSTANCE]/private/instances
+.. http:post:: [/instances/$INSTANCE]/management/instances
This request will be used to create a new merchant instance in the backend.
It is only available for the implicit ``default`` instance.
@@ -929,7 +929,7 @@ Setting up instances
}
-.. http:post:: /private/instances/$INSTANCE/auth
+.. http:post:: /management/instances/$INSTANCE/auth
.. http:post:: [/instances/$INSTANCE]/private/auth
Update the authentication settings for an instance. POST operations against
@@ -965,7 +965,7 @@ Setting up instances
}
-.. http:patch:: /private/instances/$INSTANCE
+.. http:patch:: /management/instances/$INSTANCE
.. http:patch:: [/instances/$INSTANCE]/private
Update the configuration of a merchant instance. PATCH operations against
@@ -1034,7 +1034,7 @@ Inspecting instances
--------------------
.. _instances:
-.. http:get:: /private/instances
+.. http:get:: /management/instances
This is used to return the list of all the merchant instances.
It is only available for the implicit ``default`` instance.
@@ -1079,7 +1079,7 @@ Inspecting instances
}
-.. http:get:: /private/instances/$INSTANCE
+.. http:get:: /management/instances/$INSTANCE
.. http:get:: [/instances/$INSTANCE]/private
This is used to query a specific merchant instance. GET operations against
@@ -1165,7 +1165,7 @@ Inspecting instances
Deleting instances
------------------
-.. http:delete:: /private/instances/$INSTANCE
+.. http:delete:: /management/instances/$INSTANCE
.. http:delete:: [/instances/$INSTANCE]/private
This request will be used to delete (permanently disable)