Important

You are browsing the documentation for version 3.1 of OroCommerce, OroCRM and OroPlatform, which is no longer maintained. Read version 5.0 (the latest LTS version) of the Oro documentation to get the updated information.

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

OroApiBundle

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:

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 you start creating REST API for your entities.

The auto-generated documentation and sandbox for REST API is available at /api/doc, e.g. http://demo.orocrm.com/api/doc. 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 API. For how to make other entities available via the API, see Configuration Reference.