IMPORTANT: As we revamp and transition our documentation to this site, you may find the articles you need on Liferay's Help Center.

Analytics Cloud Commerce DXP / Portal Liferay Cloud Reference

Documentation Menu

Highlighting

Remove Highlighting

Go Back

• Getting Started
• Site Building
• Content Authoring and Management
• Process Automation
• Using Search
• Collaboration and Social
• Users and Permissions
• System Administration
• Building Applications
• Liferay Internals
• Headless Delivery
  • Using Liferay as a Headless Platform
  • Using OAuth 2.0
  • Consuming APIs
  • APIs with REST Builder
• Installation and Upgrades

English

• Japanese
• English

• Liferay Learn
• DXP
• Headless Delivery

Headless Delivery

• Using Liferay as a Headless Platform
  • Ways to Connect
    • Headless REST APIs
    • GraphQL API
    • Plain Web/REST Services
  • Features
    • Work with Any Client
    • Connect Securely
    • Keep Data Size Manageable
  • Related Information
• Using OAuth 2.0
  • Creating an OAuth2 Application
    • OAuth2 Administration Reference
  • Authorizing Account Access with OAuth2
    • Authorization Code Flow
    • PKCE Extended Authorization Code Flow
    • Client Credentials and Resource Owner Flows
    • Token Use
    • Revoking Access
    • Summary
  • OAuth 2 Scopes
    • Creating a Scope for a JSONWS Service
    • Creating the Authorization Page
  • Using OAuth2 to Authorize Users
    • Set Up Liferay DXP
    • Deploy the Sample React App
      • Authorization Code Flow
      • Client Credentials Flow
      • Password Flow
    • Examine the Code
      • Authorization Grant Type
      • Client Credentials Grant Type
      • Password Grant Type
    • Additional Information
  • Flow of OAuth 2.0
  • OAuth 2.0 Terminology
  • Next Steps
• Consuming APIs
  • Consuming REST Services
    • Identify the Service to Consume
    • Identify the Site Containing the Data
    • Make the Service Call Using Credentials with Access to the Data
      • Calling a Service Using Basic Auth (During Development Only)
      • Calling a Service Using OAuth2
    • Getting and Posting Data
      • Posting a Blog Entry
      • Getting All Blog Entries
      • Getting a Single Blog Entry
      • Deleting a Blog Entry
  • Consuming GraphQL APIs
    • Identify the Service to Consume
    • Identify the Site Containing the Data
    • Make the Service Call using Credentials with Access to the Data
      • Calling a GraphQL API Using Basic Auth (During Development Only)
      • Calling a Service Using OAuth2
    • Getting and Posting Data
      • Posting a Blog Entry
      • Getting All Blog Entries
      • Getting a Single Blog Entry
      • Deleting a Blog Entry
  • API Query Parameters
    • Fields Parameter
      • REST API Example
      • GraphQL API Example
    • Flatten Parameter
      • REST API Example
      • GraphQL API Example
    • Page and Page Size Parameters
      • REST API Example
      • GraphQL API Example
    • Search Parameter
      • REST API Example
      • GraphQL API Example
    • Sort Parameter
      • REST API Example
      • GraphQL API Example
  • Batch Engine API Basics - Importing Data
    • Importing Data
    • Examine the cURL Command
    • Examine the Java Class
    • Get the ImportTask Status
      • ImportTask_GET_ById.sh
      • ImportTask_GET_ById.java
    • Importing Data to a Site
      • ImportTask_POST_ToSite.sh
      • ImportTask_POST_ToSite.java
    • Put the Imported Data
      • ImportTask_PUT_ById.sh
      • ImportTask_PUT_ById.java
    • Delete the Imported Data
      • ImportTask_DELETE_ById.sh
      • ImportTask_DELETE_ById.java
    • Get Contents of the Imported Data
      • ImportTaskContent_GET_ById.sh
      • ImportTaskContent_GET_ById.java
    • Additional Information
  • Batch Engine API Basics - Exporting Data
    • Exporting Data
    • Examine the cURL Command
    • Examine the Java Class
    • Get the ExportTask Status
      • ExportTask_GET_ById.sh
      • ExportTask_GET_ById.java
    • Exporting Data from a Site
      • ExportTask_POST_ToSite.sh
      • ExportTask_POST_ToSite.java
    • Get Contents of the Exported Data
      • ExportTaskContent_GET_ById.sh
      • ExportTaskContent_GET_ById.java
    • Additional Information
  • Making Unauthenticated Requests
    • Relaxing API Restrictions via Service Access Policy
    • Confirming Access
  • API Headers Reference
    • Accept
      • Valid Options
      • Example
    • Accept-Language
      • Valid Options
      • Example
    • Authorization
      • Valid Options
      • Example
    • Content-Type
      • Valid Options
      • Example
    • Cookie
      • Valid Options
      • Example
    • X-Accept-All-Languages
      • Valid Options
      • Example
• APIs with REST Builder
  • Producing and Implementing APIs with REST Builder
    • Deploy an Example REST API
    • Initial Setup
    • YAML configuration
      • Add REST Builder Configuration
      • Add an Information Block to the OpenAPI Configuration
      • Define the Necessary Schemas
      • Define Your APIs
    • Run REST Builder
    • Add Your Implementation Logic
    • Conclusion
  • Next Steps

{{ card.sectionName }}

{{ card.sectionName }}

• {{ subsection.name}}

• {{ subsection.name}}

Not finding what you're looking for?

Pardon our dust as we revamp and transition our product documentation to this site. If something seems missing, please check Liferay Help Center documentation for Liferay DXP 7.2 and previous versions.

Try Liferay's Help Center