Using Liferay as a Headless Platform
ご覧のページは、お客様の利便性のために一部機械翻訳されています。また、ドキュメントは頻繁に更新が加えられており、翻訳は未完成の部分が含まれることをご了承ください。最新情報は都度公開されておりますため、必ず英語版をご参照ください。翻訳に問題がある場合は、 こちら までご連絡ください。

APIの使用

API(アプリケーションプログラミングインターフェース)は、異なるソフトウェアアプリケーション間の橋渡し役を果たし、アプリケーション同士が通信し、データを交換できるようにする。 外部APIを利用することで、開発者は既存の機能やデータソースを活用し、すべてをゼロから構築することなくアプリケーションをアップグレードできます。

RESTサービスの使用

Liferayは、プラットフォーム機能と連携するための包括的なREST APIフレームワークを提供します。 データへのアクセスや操作、カスタム統合の作成、そして完全なアプリケーションの構築が可能です。

Liferay の REST API は OpenAPI 標準に準拠しており、開発者は自分の知っているものを利用できます。 APIはLiferayのAPI Explorerを通じて文書化されており、エンドポイントとその使用方法に関する詳細情報が提供されています。

LiferayのAPIエクスプローラーは、すべてのAPIを網羅した便利なリファレンスです。

GraphQL APIの使用

Liferay は GraphQL API を完全にサポートしており、利用可能なクエリ、ミューテーション、スキーマを整理して表示する API エクスプローラーを通じてこれらの API を直接検索できます。

LiferayのGraphQLクライアントを使用して、GraphQLクエリをテストできます。

データ移行センター

Liferayのデータ移行センターは、Liferayインスタンス間のデータ転送を効率化します。 システムのアップグレード、環境の統合、または新しいプラットフォームへのデータ移行など、どのような場合でも、この機能はプロセスを簡素化します。 オブジェクト定義とエントリをエクスポートおよびインポートすることで、組織は手動操作なしにコンテンツ、構成、およびユーザーデータを移動できます。 この自動化により、エラーが減り、時間が節約され、データの整合性が確保されます。

バッチエンジンAPI - データのインポートとエクスポート

Liferayのヘッドレスバッチエンジンは、データのインポートやエクスポートを行うためのREST APIを提供します。 これらのAPIはCSV、JSON、XLSX形式をサポートしており、大規模なデータセットにも対応可能です。 さらに、一部のAPIはエクスポート時にデータをフィルタリングできます。 上級ユーザー向けには、インポートおよびエクスポート処理をコードでカスタマイズする機能が用意されています。

バッチエンジンを使用すると、異なるシステム間またはLiferayインスタンス間で大量のデータを転送したり、外部ソースからデータをインポートしたり、他のアプリケーションで使用するためにデータをエクスポートしたりすることで、Liferayを他のシステムと統合したり、レポート作成や分析に適した形式でデータをエクスポートしたりできます。

Liferay 2026.Q1+ では、 LAR エクスポートとインポート もバッチ フレームワークを使用して、サイト スコープとインスタンス スコープで多くの種類のエンティティを処理します。 ワークフローに適しているのであれば、LARファイルを使ったコンテンツのプロモーションも検討してみてください。

外部参照コードの使用

外部参照コード (ERC)を使用すると、異なるシステム間でのデータ同期とマッピングが簡単に行えます。 共通の参照点を用いることで、プラットフォーム間でデータを一貫して転送および更新することが可能になる。 データ移行プロセス中、ERC(エンタープライズレコード)を使用すると、移行前後のレコードを追跡および照合したり、データ変更の履歴を追跡したり、以前のデータを追跡したりできます。

APIを介して外部システムやデータベースとやり取りする場合、ERCはレコードの一意の識別子として機能し、データの同期とマッピングを容易にします。

つまり、Liferayはユーザーインターフェース以外でもデータを操作するためのツール一式を提供しているということだ。 さらに詳しく知りたい方は、続きをお読みください。