Platform - Liferay Learn

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...

Published Date: May 9, 24, 6:51 PM

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...

Published Date: May 9, 24, 6:51 PM

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...

Published Date: May 9, 24, 6:51 PM

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...

Published Date: May 9, 24, 6:51 PM

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,...

Published Date: May 9, 24, 6:51 PM

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...

Published Date: May 9, 24, 6:51 PM

Consuming GraphQL APIs

Consuming GraphQL APIs Liferay DXP contains GraphQL APIs for most of its applications. Here's how to consume them in three steps: Identify the API you wish to consume. Identify the site...

Published Date: May 9, 24, 6:51 PM

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: ...

Published Date: May 9, 24, 6:51 PM

Data Migration Center

Data Migration Center Liferay DXP 2023.Q4+/Portal 7.4 GA102+ [Beta Feature](../../system-administration/configuring-liferay/feature-flags.md#beta-feature-flags) This feature is currently behind a...

Published Date: May 9, 24, 6:51 PM

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...

Published Date: May 9, 24, 6:51 PM

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...

Published Date: May 9, 24, 6:51 PM

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...

Published Date: May 9, 24, 6:51 PM

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...

Published Date: May 9, 24, 6:51 PM

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)....

Published Date: May 9, 24, 6:51 PM

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...

Published Date: May 9, 24, 6:51 PM

OAuth 2 Scopes

OAuth 2 Scopes In OAuth 2.0, applications are granted access to limited subsets of user data. These are called scopes (not to be confused with Liferay scopes). You can create them in two ways: ...

Published Date: May 9, 24, 6:51 PM

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...

Published Date: May 9, 24, 6:51 PM

DXP

DXP Welcome to the official documentation for the latest versions (7.3 and 7.4+) of Liferay DXP and Liferay Portal! Liferay DXP is the commercially supported and enterprise ready platform used...

Published Date: May 9, 24, 6:51 PM

Authentication Basics

Authentication Basics By default, Liferay DXP uses the Sign In widget to authenticate users. The Sign In widget appears on the default home page at http[s]://[server-name:port]/web/guest/home. If...

Published Date: May 9, 24, 6:52 PM

Configuring Single Sign-On

Configuring Single Sign-On Liferay Portal/DXP supports many ways of authenticating, from token-based solutions to standards such as OpenID Connect and SAML. With all the available options, you...

Published Date: May 9, 24, 6:52 PM