Apache OFBiz is an open-source enterprise resource planning (ERP) system providing a suite of integrated business applications for CRM, e-commerce, supply chain management, manufacturing, accounting, order management, inventory, and warehousing. Built on a service-oriented architecture with a service engine, entity engine, and widget framework, OFBiz exposes a REST API plugin allowing any exported service to be invoked via JWT-authenticated HTTP endpoints. Governed by the Apache Software Foundation under the Apache License 2.0. Written in Java with Groovy scripting support.
URL: https://raw.githubusercontent.com/api-evangelist/apache-ofbiz/refs/heads/main/apis.yml
Run: Capabilities Using Naftiko
- ERP, CRM, E-Commerce, Business Applications, Apache, Java, Open Source, Supply Chain
- Created: 2026-03-16
- Modified: 2026-04-19
REST API plugin for Apache OFBiz that exposes any exported OFBiz service as a RESTful endpoint. Clients authenticate via HTTP Basic Auth to obtain a JWT token, then invoke services via GET (with URL-encoded JSON parameters) or POST (with JSON request body). Swagger UI is available at /docs/swagger-ui.html when the plugin is installed.
Human URL: https://github.com/apache/ofbiz-plugins/tree/trunk/rest-api
- REST, JWT, Service Engine, ERP
- Documentation
- OpenAPI
- JSONSchema - Token Response Schema
- JSONSchema - Service Entry Schema
- JSONSchema - Service Response Schema
- GitHub Repository
- GitHub Organization
- Documentation
- Getting Started
- Tutorials
- FAQ
- Release Notes
- Terms of Service
- Support
- Stack Overflow
- Spectral Rules
- Naftiko Capability
- Vocabulary
- JSON-LD Context
| Name | Description |
|---|---|
| Service-Oriented Architecture | All business logic encapsulated in services accessible via multiple protocols including REST, XML-RPC, and Java. |
| REST API Plugin | Plugin enabling any exported OFBiz service to be invoked via RESTful HTTP endpoints with JWT authentication. |
| JWT Authentication | OAuth2-compatible JWT-based authentication with access tokens and refresh tokens for secure API access. |
| Entity Engine | Flexible data access layer supporting multiple databases with entity-based query API and relationship management. |
| Service Engine | Central business logic executor with transaction management, error handling, and event-driven service chaining. |
| Swagger UI Integration | Built-in Swagger/OpenAPI UI at /docs/swagger-ui.html for API exploration and testing when REST plugin is deployed. |
| Groovy Scripting | Groovy scripting support for service implementations and customizations without Java compilation. |
| Plugin Architecture | Modular plugin system allowing feature extension without modifying core framework code. |
| Multi-Module ERP | Integrated modules for accounting, order management, inventory, manufacturing, CRM, e-commerce, and HR. |
| Widget Framework | XML-based UI component framework for building consistent web interfaces across ERP modules. |
| Name | Description |
|---|---|
| ERP System Integration | Integrate external systems (CRM, WMS, payment processors) with OFBiz via REST API service calls. |
| E-Commerce Backend | Use OFBiz as a headless e-commerce backend with product catalog, pricing, order management, and fulfillment services. |
| Supply Chain Automation | Automate supply chain workflows including purchase orders, inventory updates, and supplier communications via REST services. |
| Accounting Automation | Automate accounting entries, invoicing, AR/AP processing, and financial reporting via OFBiz service API. |
| Manufacturing Operations | Manage manufacturing resource planning, work orders, bill of materials, and production scheduling via OFBiz services. |
| Custom Business Workflows | Build custom business process automations by chaining OFBiz services via the REST API. |
| Name | Description |
|---|---|
| Apache Solr | Integration for product and content search indexing across OFBiz data. |
| Groovy | Groovy scripting engine integration for service implementations and data transformations. |
| PostgreSQL | Supported relational database backend via the OFBiz entity engine. |
| MySQL | Supported relational database backend for OFBiz data persistence. |
| Docker | Official Docker support for containerized OFBiz deployments. |
| Swagger UI | OpenAPI documentation and testing interface bundled with the REST API plugin. |
Machine-readable API specifications organized by format.
- Token Data
- Token Response
- Refresh Request
- Service Link
- Service Entry
- Service List Response
- Service Response
- Token Data
- Token Response
- Refresh Request
- Service Link
- Service Entry
- Service List Response
- Service Response
Naftiko capabilities organized as shared per-API definitions composed into customer-facing workflows.
- Apache OFBiz REST API — 5 operations for authentication, service discovery, and invocation
| Workflow | APIs Combined | Tools | Persona |
|---|---|---|---|
| Apache OFBiz ERP Operations | Apache OFBiz REST API | 5 | ERP Administrator, Integration Engineer |
- Apache OFBiz Vocabulary — Unified taxonomy mapping 2 resources, 5 actions, 1 workflow, and 2 personas across operational (OpenAPI) and capability (Naftiko) dimensions
- Apache OFBiz Spectral Rules — 28 rules across 10 categories enforcing Apache OFBiz REST API conventions
FN: Kin Lane
Email: info@apievangelist.com