Capability

Integration

Liferay is designed to be standards-compliant and highly interoperable. Connect Liferay DXP with external systems using SOAP, REST, GraphQL, and more to unite third-party software, legacy systems, and data.

Headless APIs, Remote Apps (Client Extensions), API Builder, and integrations with SSO platforms are some of the examples of the features in this area.

Feature
Deployment Approach
Capability
オプション値APIの基本
Official Documentation
オプション値APIの基本 オプションの値は、オプション・アプリケーションから、またはREST APIを使って管理することができます。 headless-commerce-admin-catalog サービスを呼び出して、オプション値を作成・管理する。 オプション値の追加 Option Value API Basics をダウンロードして解凍します。 curl...
公開日: 2024/05/09 18:46
Product Delivery API Basics
Official Documentation
Product Delivery API Basics Product API Basics covers the admin API used for creating and managing products. To display product data in your storefront, you must use the Product Delivery API. Call...
公開日: 2024/11/16 15:30
仕様書APIの基礎知識
Official Documentation
仕様書APIの基礎知識 アプリケーションメニューやREST APIで商品仕様を管理することができます。 headless-commerce-admin-catalog サービスを呼び出し、仕様を作成・管理する。 仕様を追加する Liferayが起動したら、 Specification API Basics をダウンロードし、解凍してください。 curl...
公開日: 2024/05/09 18:46
Product API - 複数のSKUを持つ商品の作成
Official Documentation
Product API - 複数のSKUを持つ商品の作成 商品APIまたは商品アプリケーションを使用して、複数のアクティブなSKUを持つ商品を作成できます。 このような商品を作成するには、まず Option API を使用して、または Options アプリケーションを使用してオプション・テンプレートを作成し、オプションに値を設定する必要があります。...
公開日: 2024/05/09 18:46
製品APIの基本
Official Documentation
製品APIの基本 アプリケーションメニューから製品を管理することができますが、LiferayのREST APIを使用することもできます。 これらのサービスを呼び出して、製品を作成・管理します。 製品の追加 次に、以下の手順を実行します。 Product API Basics をダウンロードし、解凍してください。 curl...
公開日: 2024/05/09 18:46
カテゴリーとボキャブラリAPIの基本
Official Documentation
カテゴリーとボキャブラリAPIの基本 LiferayのREST APIは、Liferayのカテゴリーとボキャブラリ機能のためのサービスを提供します。 APIを使用してボキャブラリを作成および編集できます。 カテゴリーをAPIに関連付けて編集することもできます。 まずは、新しいボキャブラリを追加する例を見てみましょう。 ボキャブラリの追加 次に、以下の手順を実行します。 ...
公開日: 2024/05/09 18:50
ナレッジベースAPIの基本
Official Documentation
ナレッジベースAPIの基本 ナレッジベース記事の作成とナレッジベースの管理はLiferayのナレッジベースアプリでできますが、Liferay のREST APIを使うことも可能です。 ナレッジベースのコンテンツを作成・管理するために、これらのサービスを呼び出します。 ナレッジベースの記事を追加する 次に、以下の手順を実行します。 Knowledge Base API Basics...
公開日: 2024/11/22 22:48
ブログAPIの基本
Official Documentation
ブログAPIの基本 LiferayのREST APIは、ブログの投稿や画像を追加、変更、削除するためのサービスを提供します。 まずは、新しいブログ投稿を追加する例を見てみましょう。 ブログ投稿の追加 次に、以下の手順を実行します。 Blog API Basics をダウンロードして解凍します。 curl...
公開日: 2024/05/09 18:50
チャンネルAPIの基本
Official Documentation
チャンネルAPIの基本 アプリケーションメニューやREST APIでチャンネルを管理することができます。 headless-commerce-admin-channel サービスを呼び出して、チャンネルを作成・管理します。 チャネルを追加する Liferayが起動したら、 Channel API Basics をダウンロードし、解凍してください。 curl...
公開日: 2024/11/22 22:47
Content Management APIs
Content Management APIs You can use headless APIs to interface with most types of content in Liferay, including web content, message boards, and knowledge base articles. Here are resources to help...
公開日: 2025/06/28 18:29
開発者ガイド
Official Documentation
開発者ガイド
公開日: 2025/01/18 2:45
タグAPIの基本
Official Documentation
タグAPIの基本 LiferayのREST APIは、Liferay DXP/ポータルのタグにサービスを提供します。 APIを使用してタグを作成および編集できます。 まずは、新しいタグを追加する例を見てみましょう。 Liferayのコードベースでは、タグはキーワードと呼ばれることに注意してください。 タグの追加 次に、以下の手順を実行します。 Tags API Basics...
公開日: 2024/05/09 18:50
開発者ガイド
Official Documentation
開発者ガイド WebコンテンツAPIの基本 WebコンテンツAPIの詳細設定 REST APIによるストラクチャー・テンプレートの管理
公開日: 2024/05/09 18:51
WebコンテンツAPIの詳細設定
Official Documentation
WebコンテンツAPIの詳細設定 Liferay DXP RESTサービスを使用すると、サイトの構造化コンテンツを作成・管理することができます。 構造化コンテンツとは、Webコンテンツストラクチャーを使用する Webコンテンツ です。 ストラクチャーは、Webコンテンツの記事に含まれる作成者、概要、内容などの情報を定義します。...
公開日: 2024/05/09 18:51
掲示板APIの基本
Official Documentation
掲示板APIの基本 LiferayのHeadless Deliveryアプリケーションは、 掲示板 アプリケーションにRESTサービスを提供します。 これらのサービスでは、掲示板カテゴリやスレッド、メッセージの追加、情報の一覧表示、内容の修正や完全な削除が可能です。 ここでは、cURLコマンドとJavaクラスを使用してこれらのサービスを呼び出します。 ...
公開日: 2024/05/09 18:49
WebコンテンツAPIの基本
Official Documentation
WebコンテンツAPIの基本 Liferay DXP RESTサービスを使用すると、サイトで構造化コンテンツを作成・管理することができます。 構造化コンテンツとは、Webコンテンツストラクチャーを使用するWebコンテンツ です。 ストラクチャーは、Webコンテンツの記事に含まれる作成者、概要、内容などの情報を定義します。...
公開日: 2024/05/09 18:51
REST APIによるストラクチャーとテンプレートの管理
Official Documentation
REST APIによるストラクチャーとテンプレートの管理 Webコンテンツストラクチャーとは、Webコンテンツの記事に含まれる情報を定義するものです。 ストラクチャーにより、Webコンテンツの作成・管理がしやすくなり、コンテンツに必要な情報がすべて確実に含まれるようにします。 ストラクチャーをWebコンテンツテンプレートに関連付けることができます。...
公開日: 2024/05/09 18:51
Digital Asset Management APIs
Digital Asset Management APIs You can use headless APIs to interface with Liferay's documents and media. Here are resources to help you understand and integrate these APIs.
公開日: 2025/07/03 20:34
Web Content API Basics Using GraphQL
Official Documentation
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...
公開日: 2024/11/19 15:27
Wiki APIの基本
Official Documentation
Wiki APIの基本 LiferayのHeadless Deliveryアプリケーションは、 Wiki アプリケーションにRESTサービスを提供します。 これらのサービスを使用すると、Wikiノードとページを追加したり、それらの情報を一覧表示したり、コンテンツを変更したり、完全に削除したりできます。 ここでは、cURLコマンドとJavaクラスを使用してこれらのサービスを呼び出します。 ...
公開日: 2024/05/09 18:50
ドキュメントAPIの基本
Official Documentation
ドキュメントAPIの基本 LiferayのHeadless Deliveryアプリケーションは、 ドキュメントとメディア のRESTサービスを提供し、ドキュメントとフォルダの追加、情報の一覧表示、変更、削除などを行います。 ここでは、cURLコマンドとJavaクラスを使用してこれらのサービスを呼び出します。 ...
公開日: 2024/05/09 18:50
Document Types and Metadata Sets API Basics
Official Documentation
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...
公開日: 2025/01/30 12:26
Document Shortcut API Basics
Official Documentation
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,...
公開日: 2024/07/11 15:36
Liferay Security APIs
Liferay Security APIs You can use headless APIs to interface with important Liferay security features, including CAPTCHA configurations and SCIM. Here are resources to help you understand and...
公開日: 2025/06/28 18:30
SCIM Group API Basics
Official Documentation
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...
公開日: 2024/05/09 18:52
Captcha API Basics
Official Documentation
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...
公開日: 2024/05/09 18:52
Headless API を検索
Official Documentation
Headless API を検索 {bdg-link-primary} ベータ機能 ` 7.4 U88+ および GA88+ Liferay の検索ページからコンテンツ を検索できますが、 portal-search-rest API エンドポイントを使うこともできます。 Liferay をローカルで実行している場合、ログインした状態で にアクセスして API を調べることができます。...
公開日: 2024/05/09 18:59
Search API Basics
Official Documentation
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...
公開日: 2024/09/07 15:46
SCIM Resource Type, Service Provider, and Schema Basics
Official Documentation
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...
公開日: 2025/05/27 15:40
Process Automation APIs
Process Automation APIs You can use headless APIs to interface with automation features in Liferay DXP, including workflows. Here are resources to help you understand and integrate these APIs to...
公開日: 2025/06/28 18:30
Search Suggestions API
Official Documentation
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...
公開日: 2024/09/07 15:46
Workflow Definition Link API Basics
Official Documentation
Workflow Definition Link API Basics Liferay DXP 2025.Q1+/Portal GA132+ You can manage workflow definition links from the Liferay UI or using Liferay's REST APIs. In Liferay, the Control Panel →...
公開日: 2025/02/19 12:28
SCIM User API Basics
Official Documentation
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...
公開日: 2024/05/09 18:52
ナビゲーションメニューAPIの基本
Official Documentation
ナビゲーションメニューAPIの基本 LiferayのREST APIは、Liferayのナビゲーションメニューにサービスを提供します。 APIを使用してナビゲーションメニューを作成および編集できます。 まずは、新しいナビゲーションメニューを追加する例を見てみましょう。 ナビゲーションメニューの追加 次に、以下の手順を実行します。 Categories and Vocabulary...
公開日: 2024/05/09 18:58
Account Groups API Basics
Official Documentation
Account Groups API Basics Liferay DXP/Portal 7.4+ You can manage account groups from the Applications menu or use Liferay's REST APIs. Call these services to create and manage account groups. ...
公開日: 2025/02/13 12:50
開発者ガイド
Official Documentation
開発者ガイド
公開日: 2024/05/09 18:58
開発者ガイド
Official Documentation
開発者ガイド UADフレームワークの追加 アカウントAPIの基本 アカウントユーザーとロールのAPI ユーザーアカウントAPIの基本 組織APIの基本 ロールAPIの基本 User Groups APIの基本 Countries API の基本 Regions API の基本
公開日: 2024/05/09 18:59
組織 API の基本
Official Documentation
組織 API の基本 アプリケーションメニューから Create and Manage Organizations を利用できますが、Liferay の REST API を利用することもできます。 組織を管理するためにこれらのサービスを呼び出す。 組織の追加 次に、以下の手順に従います。 Organizations API Basics をダウンロードして解凍する。 curl...
公開日: 2024/05/09 18:59
アカウントユーザーとロールのAPI
Official Documentation
アカウントユーザーとロールのAPI アプリケーションメニューから アカウントユーザー と アカウントロール を管理することができますが、LiferayのREST APIを利用することもできます。 これらのサービスを呼び出して、アカウントユーザーとロールの作成と管理を行います。 アカウントユーザーの追加 次に、以下の手順を実行します。 Accounts API Basics...
公開日: 2024/05/09 18:59
各国APIの基本
Official Documentation
各国APIの基本 Liferay 7.4 U24+ および GA24+ LiferayのRest APIを使用して国を作成し、管理します。 国の追加 次に、以下の手順に従います。 Countries API Basics をダウンロードして解凍する。 curl...
公開日: 2024/05/09 18:59
住所APIの基本
Official Documentation
住所APIの基本 liferay DXP/Portal 7.4+. Liferay の REST API を使用して郵便住所を管理します。 アカウントに住所を追加する 次に、以下の手順に従います。 Postal Address API Basics をダウンロードして解凍する。 curl...
公開日: 2024/05/09 18:59
アカウントAPIの基本
Official Documentation
アカウントAPIの基本 Liferay DXP/Portal 7.4以降 アプリケーションメニューから アカウント を管理することができますが、LiferayのREST APIを利用することもできます。 これらのサービスを呼び出して、アカウントの作成や管理を行います。 アカウントの追加 次に、以下の手順に従います。 Accounts API Basics...
公開日: 2025/02/12 13:01
UADフレームワークの追加
Official Documentation
UADフレームワークの追加 Liferayのユーザー関連データ（UAD）管理ツールでユーザーデータを管理・削除することができます。 本ツールは、Liferayの多くのアプリケーション（ブログ、ドキュメントとメディア、掲示板など）ですぐに利用できます。 このフレームワークは、お客様のカスタムアプリケーションに適用することも可能です。 この作業は、...
公開日: 2024/05/09 18:59
リージョンAPIの基本
Official Documentation
リージョンAPIの基本 Liferay 7.4 U24+ および GA24+ Liferay の REST API を使ってリージョンを作成・管理します。 リージョンの追加 次に、以下の手順に従います。 Regions API Basics をダウンロードして解凍する。 curl...
公開日: 2024/05/09 18:59
ユーザーグループAPIの基本
Official Documentation
ユーザーグループAPIの基本 アプリケーションメニューから Create and Manage User Groups ができますが、Liferay の REST API を使うこともできます。 これらのサービスを呼び出して、ユーザーグループを管理する。 ユーザーグループの追加 その後、以下の手順に従ってください： User Groups API Basics...
公開日: 2024/05/09 18:59
ユーザーアカウントAPIの基本
Official Documentation
ユーザーアカウントAPIの基本 コントロールパネルから ユーザーの追加と管理 ができますが、Liferay の REST API を使うこともできます。 これらのサービスを呼び出して、ユーザーの追加、編集、削除を行うことができます。 まず、新しいユーザーを追加します。 ユーザーの追加 次に、以下の手順に従います。 User Account API Basics...
公開日: 2024/11/22 22:53
ロールAPIの基本
Official Documentation
ロールAPIの基本 アプリケーションメニューから Create and Manage Roles ができますが、Liferay の REST API を使うこともできます。 ロールを管理するためにこれらのサービスを呼び出す。 ユーザーを通常の役割に関連付ける 次に、以下の手順を実行します。 Roles API Basics をダウンロードし、解凍します。 curl...
公開日: 2024/05/09 18:59
APIクエリパラメータ
Official Documentation
APIクエリパラメータ REST API または GraphQL APIのいずれを利用する場合でも、レスポンスをフィルタリングするのに役立つさまざまなクエリパラメータが利用できます。 フィールド パラメータ このパラメータは、指定されたフィールドのみを指定して返す場合に使用します。 例えば、countries APIに問い合わせて、2文字の国コードと国名だけを返すようにします。 REST...
公開日: 2024/05/09 18:51
APIの使用
Official Documentation
APIの使用 休憩サービスの消費 GraphQL Apisの消費 データ移行センター APIクエリパラメータ バッチエンジン API の基本 - データのインポート バッチエンジン API の基本 - データのエクスポート 認証されていないリクエストの作成 外部参照コードの使用 APIヘッダーリファレンス
公開日: 2024/05/09 18:51
APIヘッダーリファレンス
Official Documentation
APIヘッダーリファレンス この記事では、Headless APIリクエストを行うときに使用できるヘッダーについて説明します。 Accept Accept-Language Authorization Content-Type Cookie Accept 応答コンテンツの形式を示します。 デフォルトはjsonです。 有効なオプション json xml 例...
公開日: 2024/05/09 18:51
ヘッドレスデリバリー
ヘッドレスデリバリー
公開日: 2024/05/09 18:51
バッチエンジンAPIの基本 - データのエクスポート
Official Documentation
バッチエンジンAPIの基本 - データのエクスポート Liferayのヘッドレスバッチエンジンは、データのインポートやエクスポートを行うためのREST APIを提供します。 これらのサービスを呼び出して、Liferayにデータをエクスポートします。 データのエクスポート 次に、以下の手順に従います。 Batch Engine API Basics をダウンロードして解凍する。 ...
公開日: 2024/05/09 18:51
RESTサービスの使用
Official Documentation
RESTサービスの使用 Liferay DXPには、ほとんどのアプリケーションでRESTサービスが含まれています。 これらのサービスは完全に OpenAPI に準拠しています。 ここでは、それらを使用する方法を紹介します。 必要なステップはわずか3つです。 使用するサービスを特定します。 必要なデータを含むサイトを特定します。 ...
公開日: 2024/05/09 18:51
Configuring JSON Web Services
Official Documentation
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...
公開日: 2024/11/16 15:32
GraphQL APIの使用
Official Documentation
GraphQL APIの使用 Liferay DXPには、ほとんどのアプリケーションに対応している GraphQL APIが含まれています。 ここでは、それらを使用する方法を紹介します。 必要なステップはわずか3つです。 使用するAPIを特定します。 必要なデータを含むサイトを特定します。 データにアクセスできる資格情報を使用してAPI呼び出しを行います。 GraphQL...
公開日: 2024/05/09 18:51
バッチエンジンAPIの基本 - データのインポート
Official Documentation
バッチエンジンAPIの基本 - データのインポート Liferayのヘッドレスバッチエンジンは、データのインポートやエクスポートを行うためのREST APIを提供します。 これらのサービスを呼び出して、Liferayにデータをインポートします。 データのインポート その後、以下の手順に従ってください： Batch Engine API Basics をダウンロードして解凍する。 ...
公開日: 2024/05/09 18:51
サンプルAPIチュートリアル
Official Documentation
サンプルAPIチュートリアル リクエスト例とサンプルコードを含むAPIチュートリアルのサンプルについては、以下のリンクをたどってください。 サイトの構築 ナビゲーションメニューAPIの基本 コンテンツのオーサリングと管理 ブログ API基礎 カテゴリーと語彙 API の基本 ドキュメント API基礎 Tags API 基礎 ウェブコンテンツAPIの基礎 Web...
公開日: 2024/05/09 18:51
外部参照コードの使用
Official Documentation
外部参照コードの使用 Liferay DXP/Portal 7.4+ LiferayのヘッドレスAPIエンドポイントの多くは外部参照コード（ERC）をサポートしています。 ERCフィールドは、幅広いシナリオで役に立つ。 例えば、コンテンツをLiferayに移行する際、ERCフィールドに他のシステムからのユニークな参照IDを残すことができます。...
公開日: 2024/05/09 18:51
認証されていないリクエストを行う
Official Documentation
認証されていないリクエストを行う デフォルトでは、Liferay DXPはセキュリティのためにAPIアクセスを制限し、有効な応答を取得するために認証を必要とします。 ただし、場合によっては、ゲストアクセス用のAPIを開くことがよい場合があります。 認証情報を渡さずにAPIリクエストを行うと、通常、エラー応答が発生します。 curl...
公開日: 2024/05/09 18:51
OAuth 2.0を使用する
Official Documentation
OAuth 2.0を使用する OAuth 2.0は業界標準の認証プロトコルです。 ユーザーは、LiferayベースのWebサイトから選択した認証情報をさまざまなクライアントとシームレスに共有できます。 OAuth...
公開日: 2024/05/09 18:51