Product Decisions This Supports

Headless CMS Strategy: Enables seamless integration of Ibexa DXP/Open Source with modern frontend frameworks (React, Vue, Angular) via RESTful APIs, reducing dependency on traditional monolithic CMS architectures.
Decoupled Architecture: Supports microservices adoption by providing a standardized REST API layer for content management, reducing backend-frontend coupling.
Omnichannel Content Delivery: Facilitates content syndication to mobile apps, IoT devices, or third-party platforms via REST endpoints (e.g., /content, /locations, /users).
Build vs. Buy: Buy for enterprises needing Ibexa’s enterprise-grade features (e.g., advanced content modeling, workflows) without reinventing the wheel. Build only if requiring highly customized, non-standard API behaviors.
Roadmap Priorities:
- Phase 1: Integrate Ibexa REST API with existing frontend apps (e.g., React admin dashboards) to replace legacy admin interfaces.
- Phase 2: Extend API for headless commerce (e.g., product catalogs, promotions) by leveraging Ibexa’s content-type flexibility.
- Phase 3: Automate content workflows via API (e.g., publish/unpublish, versioning) to reduce manual CMS operations.
Use Cases:
- Digital Experience Platforms (DXP): Unify content, user profiles, and personalization APIs under one roof.
- Content-as-a-Service (CaaS): Expose Ibexa content to external partners or marketplaces via API.
- Legacy System Modernization: Replace SOAP/XML-based integrations with REST for better scalability and tooling support.

When to Consider This Package

Adopt This Package If:

Your team is using Ibexa DXP/Open Source and needs a production-ready REST API layer without building from scratch.
You require OpenAPI-compatible endpoints for content, users, locations, and workflows (e.g., /content/{id}, /publish, /trash).
Your roadmap includes headless CMS, decoupled architectures, or microservices that need Ibexa’s content capabilities.
You need enterprise-grade features like:
- Token-based authentication (OAuth2/JWT compatible).
- Advanced content search/filtering (e.g., ContentTypeGroupName, IsBookmarked criteria).
- Media handling (e.g., file uploads via x-ibexa-example-file header).
Your stack includes Symfony 7.4 LTS or later (package is optimized for this version).
You want to reduce technical debt by leveraging Ibexa’s battle-tested API layer.

Look Elsewhere If:

You’re not using Ibexa DXP/Open Source: This package is tightly coupled to Ibexa’s ecosystem. Alternatives like API Platform or Spatie Laravel API Resources may fit better.
You need GraphQL: Ibexa REST is REST-only; consider Ibexa GraphQL Bundle or Laravel GraphQL for GraphQL needs.
Your use case requires real-time updates: REST is pull-based; explore WebSockets or Mercure for push notifications.
You’re on PHP < 8.3: The package mandates PHP 8.3+ (as of v5.0.0).
You need custom API behaviors beyond Ibexa’s defaults (e.g., non-standard content structures). A custom Laravel resource layer may be more flexible.
Your team lacks Ibexa expertise: The package assumes familiarity with Ibexa’s content model, workflows, and licensing (dual GPL/Ibexa BUL).

How to Pitch It (Stakeholders)

For Executives:

"Ibexa REST Bundle is a strategic enabler for our headless CMS and digital transformation initiatives. By adopting this package, we can:

Accelerate time-to-market for new digital experiences (e.g., mobile apps, IoT) by leveraging Ibexa’s enterprise-grade content management via REST APIs.
Reduce integration costs by replacing custom API development with a maintained, OpenAPI-compatible layer.
Future-proof our architecture with microservices-ready endpoints for content, users, and workflows, aligning with our decoupled roadmap.
Unlock omnichannel content delivery without reinventing the wheel—ideal for syndication to partners or third-party platforms. This is a ‘buy vs. build’ win: Ibexa’s team has invested heavily in this API, and we avoid the risk of technical debt from a custom solution. The dual GPL/Ibexa BUL license ensures compliance while granting us flexibility for enterprise use."

For Engineering/Tech Leads:

"The Ibexa REST Bundle provides a production-ready, Symfony 7.4-optimized API layer for Ibexa DXP/Open Source, addressing key pain points:

Standardized Endpoints: Out-of-the-box REST routes for content (/content), locations (/locations), users (/users), and workflows (/publish, /trash), all OpenAPI-compatible.
Performance: Built on Ibexa’s high-performance core, with support for advanced filtering (e.g., ContentTypeGroupName, IsBookmarked) and media handling (file uploads via headers).
Security: Token-based auth (OAuth2/JWT-ready) and Symfony’s authenticator manager integration. No need to build auth from scratch.
Extensibility: Supports custom media types, nullable type declarations, and deep content-type search APIs—ideal for complex content models.
Tooling: Integrates with modern frontend stacks (React/Vue) via Swagger/OpenAPI docs and JSON:API-like responses. Recommendation: Adopt for Phase 1 to replace legacy admin interfaces and enable headless delivery. Pair with Ibexa’s GraphQL bundle if real-time needs emerge later. Minimal dev overhead—just configure routes and authentication."*

For Developers:

"Here’s why this package is a game-changer for Ibexa projects:

No More Boilerplate: Skip writing CRUD endpoints for content/locations/users. The bundle provides 100+ endpoints (e.g., /content/{id}/versions, /locations/{id}/move) with proper validation and serialization.
Symfony 7.4 + PHP 8.3: Modern tooling with nullable types, rector rules, and Symfony’s authenticator manager—no legacy cruft.
Content Search Made Easy: Use criterion parsers (e.g., ContentName, FileSize) to filter content via query params. Example:
```
GET /content?ContentName=product&ContentTypeGroupName=commerce
```
Media Handling: Upload files with headers like x-ibexa-example-file—no manual multipart form setup.
Debugging: OpenAPI docs at /api/doc (Swagger UI) and JSON:API responses for frontend consistency. How to Start:

Install via Composer: composer require ibexa/rest.
Configure routes in config/packages/ibexa_rest.yaml.
Secure endpoints with Symfony’s security component (e.g., API tokens).
Extend with custom controllers if needed (e.g., for non-standard content types). Pro Tip: Use the supported_media_types flag to restrict endpoints to specific content types (e.g., application/vnd.ibexa.product+json)."*

Rest Laravel Package