From dad6a7776af85876fe9f9e1a3544d4accc457364 Mon Sep 17 00:00:00 2001 From: sushma gupta Date: Fri, 19 Jan 2024 15:08:33 +0100 Subject: [PATCH 1/3] Update references --- resources/references/api-reference/index.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/resources/references/api-reference/index.md b/resources/references/api-reference/index.md index 50b374e74..7b1646ab2 100644 --- a/resources/references/api-reference/index.md +++ b/resources/references/api-reference/index.md @@ -8,5 +8,11 @@ nav: # API Reference The API references provide detailed information about the available endpoints, methods, parameters, request and response formats, and authentication mechanisms of an API. It provides essential information on how to interact with the API, what data can be sent or received, and how to handle different API responses. - + These references guide you to use the correct syntax, understand the expected input and output formats, implement the necessary authentication mechanisms and successful API requests and effectively utilize the functionality provided by the API in your applications. + +There are two dedicated API reference documents for your reference: + +* [Store API reference](https://shopware.stoplight.io/docs/store-api/38777d33d92dc-quick-start-guide) - Primarily focused on providing functionalities related customer-facing aspects of an online platform. You can access and manipulate data associated with products, customer interactions, shopping carts, etc that directly impact the user experience on the front end. It caters to both anonymous users and authenticated users. + +* [Admin API reference](https://shopware.stoplight.io/docs/admin-api/twpxvnspkg3yu-quick-start-guide) - Primarily designed to manage and configure the backend or administrative aspects of an online platform. You can structure data exchanges, handle bulk operations, synchronize data between components, import-export data, and more to handle related tasks to backend operations. From bc397d426aaa437b2422dc195ed3cdd37806d104 Mon Sep 17 00:00:00 2001 From: sushma gupta Date: Fri, 19 Jan 2024 15:10:41 +0100 Subject: [PATCH 2/3] update text --- resources/references/api-reference/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/resources/references/api-reference/index.md b/resources/references/api-reference/index.md index 7b1646ab2..305a79035 100644 --- a/resources/references/api-reference/index.md +++ b/resources/references/api-reference/index.md @@ -13,6 +13,6 @@ These references guide you to use the correct syntax, understand the expected in There are two dedicated API reference documents for your reference: -* [Store API reference](https://shopware.stoplight.io/docs/store-api/38777d33d92dc-quick-start-guide) - Primarily focused on providing functionalities related customer-facing aspects of an online platform. You can access and manipulate data associated with products, customer interactions, shopping carts, etc that directly impact the user experience on the front end. It caters to both anonymous users and authenticated users. +* [Store API reference](https://shopware.stoplight.io/docs/store-api/38777d33d92dc-quick-start-guide) - Primarily focused on providing functionalities related to customer-facing aspects of an online platform. You can access and manipulate data associated with products, customer interactions, shopping carts, etc, directly impacting the user experience on the frontend. It caters to both anonymous users and authenticated users. * [Admin API reference](https://shopware.stoplight.io/docs/admin-api/twpxvnspkg3yu-quick-start-guide) - Primarily designed to manage and configure the backend or administrative aspects of an online platform. You can structure data exchanges, handle bulk operations, synchronize data between components, import-export data, and more to handle related tasks to backend operations. From 98ac0fbd618c8a0a3203e2435afa7f191e9bfaca Mon Sep 17 00:00:00 2001 From: sushma gupta Date: Fri, 19 Jan 2024 15:27:43 +0100 Subject: [PATCH 3/3] suggestions updated --- resources/references/api-reference/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/resources/references/api-reference/index.md b/resources/references/api-reference/index.md index 305a79035..0c108436a 100644 --- a/resources/references/api-reference/index.md +++ b/resources/references/api-reference/index.md @@ -13,6 +13,6 @@ These references guide you to use the correct syntax, understand the expected in There are two dedicated API reference documents for your reference: -* [Store API reference](https://shopware.stoplight.io/docs/store-api/38777d33d92dc-quick-start-guide) - Primarily focused on providing functionalities related to customer-facing aspects of an online platform. You can access and manipulate data associated with products, customer interactions, shopping carts, etc, directly impacting the user experience on the frontend. It caters to both anonymous users and authenticated users. +* [Store API reference](https://shopware.stoplight.io/docs/store-api/38777d33d92dc-quick-start-guide) - Focused on customer-facing aspects, the Store API allows you to access and manipulate data related to products, customer interactions, shopping carts, and others that significantly impact the frontend user experience. It caters to both anonymous and authenticated users. -* [Admin API reference](https://shopware.stoplight.io/docs/admin-api/twpxvnspkg3yu-quick-start-guide) - Primarily designed to manage and configure the backend or administrative aspects of an online platform. You can structure data exchanges, handle bulk operations, synchronize data between components, import-export data, and more to handle related tasks to backend operations. +* [Admin API reference](https://shopware.stoplight.io/docs/admin-api/twpxvnspkg3yu-quick-start-guide) - Primarily for backend and administrative functions, the Admin API enables structured data exchanges, bulk operations, data synchronization, and import-export tasks, addressing the backend needs of the Shopware platform.