OroApiBundle enables 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 bundle opens REST API that conforms the JSON API specification and enables CRUD operations support for the application ORM entities.
The implementation of the OroApiBundle is 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 entity object.
The main format for REST API is described at JSON API. Please make sure that you are familiar with it before you start creating REST API for your entities.
The auto-generated documentation and sandbox for REST API is available at /api/doc/rest_json_api, e.g. http://demo.orocrm.com/api/doc/rest_json_api. If you plan to use the sandbox, first make sure that you have generated an API key on the user profile page.
By default, only custom entities, dictionaries, and enumerations are accessible through the data API. For how to make other entities available via the data API, see Configuration Reference.