Important

You are browsing documentation for version 5.1 of OroCommerce, supported until March 2026. Read the documentation for version 6.0 (the latest LTS version) to get up-to-date information.

See our Release Process documentation for more information on the currently supported and upcoming releases.

API Developer Guide

This section describes the Web API development framework for the application data. It provides the ability to define API in the YAML configuration files regardless of standards or formats. Out-of-the-box, the framework opens REST API that conforms the JSON:API specification and enables CRUD operations support for the application ORM entities.

The Web API development framework is implemented by OroApiBundle and based on the following components:

• ChainProcessor — Organizes data processing flow.

• EntitySerializer — Provides fast access to entities data.

• Symfony Form — Provides a flexible way to map request data to the entity object.

FOSRestBundle and NelmioApiDocBundle are also used for REST API.

Note

The main format for REST API is described at JSON:API. Please make sure that you are familiar with it before creating REST API for your entities.

The auto-generated documentation and sandbox for REST API is available in the /api/doc, e.g., http://demo.orocrm.com/api/doc.

By default, only custom entities, dictionaries, and enumerations are accessible through the back-office API. For how to make other entities available via the API, see Configuration Reference.

• CLI Commands
• Configure Stateless Security Firewalls
• Configure Feature Depended Firewall Listeners
• General Configuration
• Configuration Reference
• Configuration Extras
• Configuration Extensions
• Forms and Validators Configuration
• Documenting API Resources
• Actions
• Request Type
• Processors
• Headers
• Filters
• Post Processors
• How to
• CORS Configuration
• Testing REST API
• Storefront REST API
• Storefront Routes
• Batch API