Inuar Reference Data API Bundle

A Symfony bundle for Akeneo PIM that exposes reference data entities via a REST API.

Requirements

• PHP >= 8.1
• Symfony ^5.4
• Doctrine DBAL ^2.13.4
• Akeneo PIM with CustomEntityBundle installed

Installation

Install via Composer:

composer require inuar/reference-data-api-bundle

Register the bundle in your Akeneo application's config/bundles.php:

return [
    // ...
    Inuar\Bundle\ReferenceDataApiBundle\InuarReferenceDataApiBundle::class => ['all' => true],
];

Import the bundle routes in your config/routes.yaml:

inuar_reference_data_api:
    resource: "@InuarReferenceDataApiBundle/Resources/config/routing.yml"

API Endpoints

All endpoints are read-only and return JSON.

List all records for a reference data entity

GET /rest/v1/reference-data/{entityName}

Returns an array of all records for the given entity, each normalised to the standard format.

Example:

GET /rest/v1/reference-data/color

[
    { "code": "red", "labels": { "en_US": "Red" } },
    { "code": "blue", "labels": { "en_US": "Blue" } }
]

Get a single record by code

GET /rest/v1/reference-data/{entityName}/{code}

Returns a single record matching the given code. Responds with 404 Not Found if the entity type or the specific record does not exist.

Example:

GET /rest/v1/reference-data/color/red

{ "code": "red", "labels": { "en_US": "Red" } }

How It Works

The bundle resolves {entityName} against Akeneo's CustomEntityBundle configuration registry to find the corresponding entity class, then queries the database via Doctrine and serialises results using Akeneo's pim_serializer with the standard normalisation format.

License

This bundle is developed by Inuar Technology and released under the MIT license.