APIs - Storefront API

Podcast

Play an AI-generated podcast conversation about this lesson

Questions and Answers

What is the purpose of the initial AJAX request to '/identity/connect/token'?

To obtain an access token for authorization. (correct)

To retrieve product information.

To create a new user account.

To start a new session in the application.

Which HTTP method is used when creating a session with the AJAX request to '/api/v1/sessions'?

PUT

DELETE

GET

POST (correct)

What does the 'beforeSend' function in the second AJAX request handle?

Attaching the access token to the request. (correct)

Validating the user credentials.

Defining the data to be sent with the request.

Setting the content type for the request.

Why is the bearer token not included in the request to retrieve the product catalog?

The product catalog does not require authentication. Signup and view all the answers

Which property of the AJAX request to '/api/v1/products' specifies the page number?

data Signup and view all the answers

What will the success callback function of the request to retrieve all categories log?

A list of all categories in JSON format. Signup and view all the answers

What mechanism is primarily used for handling cross-domain requests in the initial AJAX call?

CORS (Cross-Origin Resource Sharing) Signup and view all the answers

When searching for a product using a query, which method should be specified to retrieve the relevant products?

GET Signup and view all the answers

What HTTP method is used to add a product to the shopping cart?

POST Signup and view all the answers

Which of the following data fields is necessary when updating the quantity of a product in the shopping cart?

qtyOrdered Signup and view all the answers

What is the purpose of the 'beforeSend' function in the AJAX requests?

To set the authorization header Signup and view all the answers

What is the final step in the shopping process described?

Submitting the order Signup and view all the answers

Which URL is used to change the quantity of a specific product in the shopping cart?

api/v1/carts/current/cartlines/{cartLineId} Signup and view all the answers

In the context of submitting an order, what additional information must be provided?

Shipping address and payment method Signup and view all the answers

When the success callback is executed for adding a product, what type of data does it log?

Response data in JSON format Signup and view all the answers

Which of the following is NOT a step mentioned in managing an online shopping cart?

Add product to wishlist Signup and view all the answers

What is the primary purpose of the Storefront API?

To facilitate digital commerce activities like managing user accounts and shopping carts. Signup and view all the answers

Which two actions are involved in signing into Configured Commerce?

Authenticating with Identity Server and creating a Configured Commerce session. Signup and view all the answers

What allows for seamless upgrades in the Configured Commerce REST APIs?

Ensuring that the façade in front of the application is maintained. Signup and view all the answers

How does the Administrative API differ from the Storefront API?

The Administrative API allows access to all objects in the platform, not limited to user context. Signup and view all the answers

What sequence of actions does the basic commerce workflow using the Storefront API not include?

Changing the password for a user. Signup and view all the answers

What feature of the Storefront API enhances developer flexibility?

Allowing customizations outside of the platform. Signup and view all the answers

What is the first step in the basic commerce workflow using the Storefront API?

Sign In and Create B2B Session. Signup and view all the answers

Which HTTP verbs are primarily used in the conception of the API objects?

GET, POST, PUT, DELETE. Signup and view all the answers

What type of request is used to retrieve product details by productId?

GET Signup and view all the answers

Which data type is specified for the AJAX calls in the provided code?

json Signup and view all the answers

What is the purpose of the 'beforeSend' function in the AJAX request?

To add authorization headers before the request is sent. Signup and view all the answers

What should be modified when retrieving product details based on search results?

The productId being queried. Signup and view all the answers

How is a wishlist created in the provided code?

By sending a POST request with a name parameter. Signup and view all the answers

What information is required when adding a product to a wishlist?

The productId, quantity ordered, and unit of measure. Signup and view all the answers

What action will the second AJAX request accomplish?

It will add a product to an existing wishlist. Signup and view all the answers

Which of the following is true about the 'productId' used in the requests?

It must be unique for each product being retrieved. Signup and view all the answers

Study Notes

Configured Commerce REST APIs

The Configured Commerce REST API is made up of RESTful-based services that interact with Configured Commerce data using JSON objects.
The API objects and their respective methods are based on common HTTP verbs.

Storefront API

Built with the following considerations:
- Open up the platform for connected commerce.
- Allow developers to create customizations outside the platform.
- Offer a developer-friendly, flexible, and modern experience.
- Allow for seamless upgrades.
- Create a facade for the application to minimize interruption during improvements.
- Ensure scalability.

Storefront API vs Administrative API

Storefront API: Delivers digital commerce functionality (viewing products, adding products to carts, user account management).
Administrative API: Provides data-level access to all objects. Used for integrating other platforms requiring access to all Configured Commerce objects.

Building a Digital Commerce Workflow with Storefront API using jQuery

Sign In and Create B2B Session:
- Requires two requests: authentication with Identity Server and creation of a Configured Commerce session.
- The first request authenticates with Identity Server using a POST request to /identity/connect/token.
- The second request creates a session within Configured Commerce using a POST request to /api/v1/sessions.
Retrieve Product Catalog:
- Retrieves the product catalog available within the current context (user, customer, website).
- Uses a GET request to /api/v1/products.
Retrieve All Categories:
- Retrieves all categories.
- Uses a GET request to /api/v1/categories.
Search for Product Using a Query:
- Uses a GET request to /api/v1/products.
- Includes the query parameter for the search term.
Retrieve Product Details:
- Returns details of a specific product identified by productId.
- Uses a GET request to /api/v1/products.
- Includes the productId parameter.
Create Wishlist and Add Product to Wish List:
- Creates a new wishlist with a POST request to /api/v1/wishlists.
- Adds a product to the wishlist with a POST request to /api/v1/wishlists/{wishListId}/wishlistlines.
Add Product to Shopping Cart:
- Adds a product to the current user's cart with a POST request to /api/v1/carts/current/cartlines.
- Includes productId and qtyOrdered parameters.
Change Quantity of Product in Shopping Cart:
- Updates the quantity of a product in the cart using a PATCH request to /api/v1/carts/current/cartlines/{cartLineId}.
- Includes the id (cartLineId) and qtyOrdered parameters.
Submit Order:
- Completes the order using a PATCH request to /api/v1/carts/current.
- The request data includes updated cart details (shipping information, payment method, etc.).

Studying That Suits You

Use AI to generate personalized quizzes and flashcards to suit your learning preferences.

Description

This quiz explores the key features and functionalities of Configured Commerce REST APIs, including the distinction between Storefront and Administrative APIs. It highlights how these APIs facilitate connected commerce, enhance developer experiences, and ensure scalability. Test your knowledge on the integration and usage of these APIs in a modern storefront setup.