Last updated:

Backend API

Existing API Applications

Out of the box, Spryker Commerce OS provides API applications:

  • Storefront API that can be used for customer-facing integrations and headless commerce
  • Backend API that can be used to provide API access for the Back Office functionality directly without any additional RPC calls

Backend API Application

With the current setup out of the box, we have a Backend API application that is meant to be an API application for our Back Office. This means that with this new application, infrastructure has direct access to Zed facades from Backend API resources. Also, out of the box, we have a separate /token resource specifically for Backend API that uses Back Office users’ credentials to issue a token for a Backend API resource.

For more details about the difference between SAPI and BAPI, see Comparison of Storefront and Backend APIs.

Key Features

  • Admin-focused: Designed for administrative operations and Back Office tasks
  • Multi-format Support: Technically supports multiple conventions, with JSON:API shipped out-of-the-box
  • Direct Facade Access: Backend API resources can use direct facade access through the dependency provider and access the database directly
  • Enterprise Integration: Built for ERP, CRM, and other enterprise system integrations

Possibility to create new API applications

With the current infrastructure, projects can easily create their own API applications that would be completely separated from others. This means that resources can be added only to the new application, and users can’t access them with existing ones.

Decoupling from conventions

Storefront API is tightly coupled with a JSON:API convention, and all resources have to follow it. Backend API resources can use any implemented conventions, create new ones, or even not use any. In this case, the “no convention” approach is used, and a request and response are formatted as a plain JSON. For more details, see Create and change Backend API conventions.

Authentication

Backend API uses Back Office credentials for authentication. System administrators and enterprise integrations authenticate using administrative credentials to access backend resources.

For API key-based authentication, see Use API Key Authorization.

Request and response reference

For the Glue resource module conventions, request and response structures, HTTP status codes, and request and response headers, see Backend API request and response reference.

Data Exchange API

Backend API includes the Data Exchange API, a dynamic database API that facilitates data transfer in real-time. It enables you to build, customize, and manage database APIs tailored to your specific business requirements through a user interface.

Key benefits:

  • No coding and deploying required: API endpoints are created from the user interface
  • Rapid API generation: APIs are generated within minutes
  • Flexibility and customization: Tailor APIs to your specific needs
  • Real-time updates: Dynamic changes and on-the-fly modifications
  • Security and Access Control: Strong security measures and access controls

Learn more about Data Exchange API

Further Reading