Search Results

All Results 48
Resource Type
Deployment Approach
Capability
Feature
Batch Engine API Basics - Importing Data
Official Documentation
Batch Engine API Basics - Importing Data Liferay's Headless Batch Engine provides REST APIs to import and export data. Call these services to import data to Liferay. Importing Data Then follow...
Consuming GraphQL APIs
Official Documentation
Consuming GraphQL APIs Liferay DXP contains GraphQL APIs for most of its applications. The GraphQL APIs are available at http://[host]:[port]/o/graphql. Here's how to consume them in three steps: ...
Configuring JSON Web Services
Official Documentation
Configuring JSON Web Services Liferay’s services are exposed as JSON web services out-of-the-box. This is enabled by default. You can access these services via the API page at...
Consuming REST Services
Official Documentation
Consuming REST Services Liferay DXP contains REST services for most of its applications. These services are fully OpenAPI compliant. Here, learn how to consume them. This takes only three steps: ...
REST Builder
Official Documentation
REST Builder REST Builder is a code generation tool that makes it easy for you to take your local APIs and make them available on the web. It uses the OpenAPI Specification to generate REST and...
Data Providers
Official Documentation
Data Providers Data providers serve data that can be consumed by the Forms application. The REST Data Provider is included with the Forms application. With it, you can consume data from REST web...
Using the REST Data Provider to Populate Form Options
Official Documentation
Using the REST Data Provider to Populate Form Options Select from List fields can hold many options. Those options can be supplied automatically by using the JSON web services registered in Liferay...
API Headers Reference
Official Documentation
API Headers Reference API headers are components of HTTP requests that provide essential information to the server about the client's request and how the server should handle it. You can use API...
Batch Engine API Basics - Exporting Data
Official Documentation
Batch Engine API Basics - Exporting Data Liferay's Headless Batch Engine provides REST APIs to import and export data. Call these services to export data from Liferay. Exporting Data Then,...
Consuming APIs
Official Documentation
Consuming APIs APIs, or Application Programming Interfaces, serve as the bridge between different software applications, allowing them to communicate and exchange data. By consuming external APIs,...
API Query Parameters
Official Documentation
API Query Parameters Whether you consume REST APIs or GraphQL APIs, different query parameters are available to help you filter the responses. Fields Parameter Use this parameter to specify and...
Using External Reference Codes
Official Documentation
Using External Reference Codes Liferay DXP/Portal 7.4+ Many of Liferay's headless API endpoints support an external reference code (ERC). The ERC field is useful in wide range of scenarios. For...
Sample API Tutorials
Official Documentation
Sample API Tutorials Follow the links below for sample API tutorials that include example requests and example code. Building Applications (Objects) Custom Objects API Basics Custom Objects...
Making Unauthenticated Requests
Official Documentation
Making Unauthenticated Requests By default, Liferay DXP restricts API access for the sake of security, requiring authentication to get a valid response. However, in certain cases it may make sense...
Producing and Implementing APIs with REST Builder
Official Documentation
Producing and Implementing APIs with REST Builder With REST Builder, you can define the API you want to build, and REST Builder provides the framework and endpoints for you. Deploy an Example REST...
Container Lifecycle and API
Official Documentation
Container Lifecycle and API At a high level, the container starts Tomcat with Liferay deployed on it. Additionally, however, the container entry point provides an API for executing these use cases:...
Building a Sample API Application
Official Documentation
Building a Sample API Application Liferay DXP 2023.Q4+/Portal GA102+ [Beta Feature](../../security-and-administration/administration/configuring-liferay/feature-flags.md#beta-feature-flags) The...
API Builder
Official Documentation
API Builder Liferay DXP 2023.Q4+/Portal GA102+ [Beta Feature](../security-and-administration/administration/configuring-liferay/feature-flags.md#beta-feature-flags) This feature is currently...
Order API Basics
Official Documentation
Order API Basics You can manage orders from the Applications menu or with REST APIs. Call the headless-admin-commerce-order services to create and manage orders. Adding an Order Once Liferay is...
Inventory Management APIs
Official Documentation
Inventory Management APIs Here is a comprehensive resource for understanding and leveraging Liferay’s inventory management APIs.
Order Management APIs
Official Documentation
Order Management APIs Here is a comprehensive resource for understanding and leveraging Liferay’s order management APIs.
Warehouse API Basics
Official Documentation
Warehouse API Basics You can manage warehouses from the Applications menu or REST APIs. Call the headless-commerce-admin-inventory services to create and manage warehouses. Adding a Warehouse ...
Term API Basics
Official Documentation
Term API Basics You can manage terms and conditions from the Applications menu or with REST APIs. Use the /terms endpoint from headless-admin-commerce-order to create and manage terms and...
Order Type API Basics
Official Documentation
Order Type API Basics You can manage order types from the Applications menu or with REST APIs. Use the /order-types endpoint from headless-admin-commerce-order to create and manage order types. ...
Price List API Basics
Official Documentation
Price List API Basics You can manage price lists from the Applications menu or with REST APIs. Call the headless-admin-commerce-pricing services to create and manage price lists. Adding a Price...
Discount API Basics
Official Documentation
Discount API Basics You can manage discounts from the Applications menu or with REST APIs. Call the headless-admin-commerce-pricing services to create and manage discounts. Adding a Discount Once...
Pricing APIs
Official Documentation
Pricing APIs Use the Price List and Discount APIs to manage product pricing and discounts in Liferay Commerce programmatically. Below are basic usage examples, including common endpoints and...
Blog API Basics
Official Documentation
Blog API Basics Liferay's REST APIs provide services for adding, modifying, and deleting blog posts and images. Liferay DXP 2024.Q4+/Portal GA129+ The Blogs API now uses External Reference Codes...
Store Management Basics
Official Documentation
Store Management Basics Here is a comprehensive resource for understanding and leveraging Liferay’s Channel API basics.
Channel API Basics
Official Documentation
Channel API Basics You can manage channels from the Applications menu or with REST APIs. Call the headless-commerce-admin-channel services to create and manage channels. Adding a Channel Once...
Categories and Vocabulary API Basics
Official Documentation
Categories and Vocabulary API Basics Liferay's REST APIs provide services for Liferay's categories and vocabularies functionality. You can create and edit vocabularies with the API. You can also...
Tags API Basics
Official Documentation
Tags API Basics Liferay's REST APIs provide services for managing tags (referred to as keywords in Liferay's codebase). You can create, edit, and delete tags using the API. Start with an example of...
Advanced Web Content API
Official Documentation
Advanced Web Content API Using the Liferay DXP REST services, you can create and manage your site's structured content. Structured content is web content that uses a web content structure (or...
Web Content API Basics
Official Documentation
Web Content API Basics Using Liferay DXP REST services, you can create and manage structured content on your site. Structured content refers to web content articles that use a web content structure...
Document API Basics
Official Documentation
Document API Basics Liferay's headless delivery application provides REST services for Documents and Media that add documents and folders, list their information, modify them, delete them, and...
Web Content API Basics Using GraphQL
Official Documentation
Web Content API Basics Using GraphQL Use Liferay DXP GraphQL services to manage web content by creating, retrieving, updating, and deleting structured content on your site. Structured content...
Document Shortcut API Basics
Official Documentation
Document Shortcut API Basics Liferay's headless delivery application provides REST services for Documents and Media that add document shortcuts to sites or asset libraries, list their information,...
Managing Web Content Structures and Templates by Using the REST API
Official Documentation
Managing Web Content Structures and Templates by Using the REST API Web content structures define the information included in a web content article. Structures facilitate creating and managing web...
Web Content API
Official Documentation
Web Content API Here is a comprehensive resource for understanding and leveraging Liferay’s Web Content APIs. It supports the integration and management of web content within applications,...
Document Types and Metadata Sets API Basics
Official Documentation
Document Types and Metadata Sets API Basics Liferay DXP 2025.Q1+/Portal GA132+ Liferay's headless delivery application provides REST services for Documents and Media that add document types and...