Documentation
Liferay.com
Training
Community
Help Center
Liferay.com
Training
Community
Help Center
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
Courses
DXP / Portal
DXP 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
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
OAuth2 Scopes
Creating a Scope for a JSONWS Service
Creating the Authorization Page
Flow of OAuth 2.0
OAuth 2.0 Terminology
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
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
Query Design
Reference
Next Steps
{{ card.sectionName }}
{{ card.sectionName }}
{{ subsection.name}}
{{ subsection.name}}