Detailed information about using the Open Commerce API:
|You can interactively explore the Open Commerce APIs with API Explorer.
|You can sometimes use a batch request (a multipart HTTP request that can contain up to 50 subrequests) instead of issuing multiple separate requests.
|Useful tips for working with OCAPI.
|You can build client-side application caches or leverage Proxy caches.
|Client application identification
|You must ensure that your client application identifies itself for security and tracking purposes.
|You can take advantage of Cross-Origin Resource Sharing (CORS).
|You can get access to customer properties of business objects.
|You can customize OCAPI resources on server-side.
|You can specify a preferred data format for resources (JSON or XML).
|You can minimize network traffic and conserve server CPU usage by using a technique called expansion.
|You can specify a filter on an API request to limit the number of items in the response.
|Document contains special information.
|Global exceptions thrown by OCAPI.
|Global HTTP headers
|HTTP headers globally used by OCAPI.
|Hook Circuit Breaker
|The Hook Circuit Breaker feature improves stability and saves processing time by protecting the system from high rates of hook failures.
|You create requests based on standard HTTP methods (as defined by RFC 2616).
|HTTP status codes and faults
|You can diagnose problems or failures by examining HTTP status codes and faults.
|You can retrieve images using absolute URLs.
|JWT (JSON Web Token)
|The stateless Shop API uses JSON Web Tokens in its authentication mechanism.
|You can use the API in different locales.
|You can request metadata about the API itself, such as the current version.
|You have to authorize your Data API requests using the OAuth 2.0 protocol.
|You can configure OCAPI settings in Business Manager by modifying a JSON data structure, enabling you to control client permissions, caching, and other resource-specific behaviors.
|Describes the two optimistic locking mechanisms supported by OCAPI.
|You can use pagination to break up large responses into smaller chunks.
|You can use property selectors to limit which resource properties are returned.
|Resource States can be used for Optimistic Locking, which prevents collisions of concurrent requests, for example, the "lost update" problem.
|Allows seamless interaction between OCAPI and a session-based storefront.
|Predefined jobs that can be called with an OCAPI request.
|You must create appropriately constructed URLs to operate on resources.
|Versioning and deprecation policy
|You must ensure that your application conforms to the versioning and deprecation policy.