Search

  • Capability
  • Feature
  • Deployment Approach
API Builder
API Builder Liferay DXP 2023.Q4+/Portal 7.4 GA102+ Beta Feature This feature is currently behind a beta feature flag (LPS-178642). API endpoints currently support retrieving and creating...
Last Modified: Apr 27, 2024 3:35 AM
API Headers Reference
API Headers Reference This article documents the available headers you can use when making Headless API requests: Accept Accept-Language Authorization Content-Type CookieAccept Indicates...
Last Modified: Apr 27, 2024 3:36 AM
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...
Last Modified: Apr 27, 2024 3:35 AM
Building a Sample API Application
Building a Sample API Application Liferay DXP 2023.Q4+/Portal 7.4 GA102+ Beta Feature The API Builder is currently behind a beta feature flag (LPS-178642). API endpoints currently support...
Last Modified: Apr 27, 2024 3:35 AM
APIs with REST Builder
APIs with 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...
Last Modified: Apr 27, 2024 3:35 AM
Consuming APIs
Consuming APIs Consuming Rest Services Consuming GraphQL Apis Data Migration Center API Query Parameters Batch Engine API Basics - Importing Data Batch Engine API Basics - Exporting Data ...
Last Modified: Apr 27, 2024 3:35 AM
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 Start a new...
Last Modified: Apr 27, 2024 3:36 AM
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 Start a new...
Last Modified: Apr 27, 2024 3:36 AM
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...
Last Modified: Apr 27, 2024 3:36 AM
Consuming GraphQL APIs
Consuming GraphQL APIs Liferay DXP contains GraphQL APIs for most of its applications. Here, you'll learn how to consume them. This takes only three steps: Identify the API you wish to consume. ...
Last Modified: Apr 27, 2024 3:37 AM
Consuming REST Services
Consuming REST Services Liferay DXP contains REST services for most of its applications. These services are fully OpenAPI compliant. Here, you'll learn how to consume them. This takes only three...
Last Modified: Apr 27, 2024 3:37 AM
Data Migration Center
Data Migration Center Liferay DXP 2023.Q4+/Portal 7.4 GA102+ Beta Feature This feature is currently behind a beta feature flag (COMMERCE-8087). The data migration center currently only supports...
Last Modified: Apr 27, 2024 3:37 AM
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...
Last Modified: Apr 27, 2024 3:37 AM
Making Unauthenticated Requests
Making Unauthenticated Requests By default, Liferay DXP restricts API access for the sake of security, requiring authentication in order to get a valid response. However, in certain cases it may...
Last Modified: Apr 27, 2024 3:37 AM
Sample API Tutorials
Sample API Tutorials Follow the links below for sample API tutorials that include example requests and example code.Site Building Navigation Menu API BasicsContent Authoring and Management Blogs...
Last Modified: Apr 27, 2024 3:38 AM
Authorizing Account Access with OAuth2
Authorizing Account Access with OAuth2 Once you have an application registered, you can start authorizing users. To do that, you must construct the URL to the authorization server (Liferay DXP)....
Last Modified: Apr 27, 2024 3:38 AM
Using Liferay as a Headless Platform
Using Liferay as a Headless Platform Liferay provides a suite of APIs that perform the same kinds of actions available in the web interface. This is essential when you must get data in a...
Last Modified: Apr 27, 2024 3:38 AM
Creating an OAuth2 Application
Creating an OAuth2 Application When you have an application that can use OAuth 2.0 for authorization, you must register that application so Liferay can recognize it. Do this by accessing Control...
Last Modified: Apr 27, 2024 3:38 AM
Using OAuth 2.0
Using OAuth 2.0 OAuth 2.0 is an industry-standard authorization protocol. Users can seamlessly share select credentials from your Liferay-based website with various clients. OAuth 2.0 works by...
Last Modified: Apr 27, 2024 3:38 AM
Using OAuth2 to Authorize Users
Using OAuth2 to Authorize Users You can create applications that access Liferay's headless REST APIs using the OAuth 2.0 authorization protocol. The provided sample React app demonstrates three...
Last Modified: Apr 27, 2024 3:39 AM