Search Results

All Results 48
Ordenar por
Resource Type
Deployment Approach
Capability
Feature
Container Lifecycle and API
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:...
Store Management Basics
Store Management Basics Here is a comprehensive resource for understanding and leveraging Liferay’s Channel API basics.
Categories and Vocabulary API Basics
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...
Managing Web Content Structures and Templates by Using the REST API
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 Basics
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...
Web Content API Basics Using GraphQL
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...
Tags API Basics
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...
Web Content API
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,...
Channel API Basics
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...
Blog API Basics
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...
Advanced Web Content API
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...
Managing Object Entries Using GraphQL
Managing Object Entries Using GraphQL You can use GraphQL to manage custom object entries in Liferay efficiently. This API framework simplifies data interaction and serves as an alternative to REST...
Search Suggestions API
Search Suggestions API DXP 7.4 U36+/Portal GA36+ You can return suggestions with the using the /suggestions headless API. This API is used by Liferay's Search Bar Suggestions feature. There are...
Document API Basics
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...
Document Shortcut API Basics
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,...
Document Types and Metadata Sets API Basics
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...
Captcha API Basics
Captcha API Basics Liferay provides a headless API to retrieve and submit captchas using the SimpleCAPTCHA engine. Using the /captcha endpoint from the API Explorer, you can add captchas in your...
SCIM Group API Basics
SCIM Group API Basics Liferay DXP 2024.Q1+/Portal GA112+ Liferay provides a headless API to perform CRUD operations on SCIM groups to keep their information in sync with your company's...
SCIM Resource Type, Service Provider, and Schema Basics
SCIM Resource Type, Service Provider, and Schema Basics Liferay DXP 2025.Q2+ Liferay provides a headless API to query the SCIM resource types, service providers, and schemas available. Use the...
SCIM User API Basics
SCIM User API Basics Liferay DXP 2024.Q1+/Portal GA112+ Liferay provides a headless API to perform CRUD operations on SCIM users to keep their identity information in sync with your company's...
Search APIs
Search APIs You can search with headless APIs using the endpoints at /o/search. Search Headless APIs Availability The first search headless endpoint, /portal-search-rest, was released behind a...
Search API Basics
Search API Basics [Release Feature](../../../security-and-administration/administration/configuring-liferay/feature-flags.md#release-feature-flags) 7.4 U88+ and GA88+ You can search for content...
API Headers Reference
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...
Consuming APIs
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
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...
Batch Engine API Basics - Exporting Data
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,...
Batch Engine API Basics - Importing Data
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...
Configuring JSON Web Services
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 GraphQL APIs
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: ...
Consuming REST Services
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: ...
Making Unauthenticated Requests
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...
Using External Reference Codes
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
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...
REST Builder
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...
Producing and Implementing APIs with REST Builder
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...
Data Providers
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
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 Builder
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...
Building a Sample API Application
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...
Inventory Management APIs
Inventory Management APIs Here is a comprehensive resource for understanding and leveraging Liferay’s inventory management APIs.