APIの使用
API（アプリケーションプログラミングインターフェース）は、異なるソフトウェアアプリケーション間の橋渡し役を果たし、アプリケーション同士が通信し、データを交換できるようにする。 外部APIを利用することで、開発者は既存の機能やデータソースを活用し、すべてをゼロから構築することなくアプリケーションをアップグレードできます。
RESTサービスの使用
Liferayは、プラットフォーム機能と連携するための包括的なREST APIフレームワークを提供します。 データへのアクセスや操作、カスタム統合の作成、そして完全なアプリケーションの構築が可能です。
Liferay の REST API は OpenAPI 標準に準拠しており、開発者は自分の知っているものを利用できます。 APIはLiferayのAPI Explorerを通じて文書化されており、エンドポイントとその使用方法に関する詳細情報が提供されています。
GraphQL APIの使用
Liferay は GraphQL API を完全にサポートしており、利用可能なクエリ、ミューテーション、スキーマを整理して表示する API エクスプローラーを通じてこれらの API を直接検索できます。
データ取得：検索インデックスとデータベースの比較
Liferayは、検索インデックスまたはデータベースのいずれかからAPIクエリを解決します。呼び出しがどちらのソースを使用しているかを知ることで、新しく作成されたデータが利用可能になったタイミングがわかります。
コレクションクエリとフィルタクエリは、Liferay の 検索エンジン がデータベースとは別に管理する検索インデックスに対して実行されます。 これには、REST と GraphQL の両方で、リスト エンドポイントと フィルタ パラメータまたは引数を受け取るクエリが含まれます。 Liferayは、データベースへの書き込みがコミットされた後に検索インデックスを更新するため、インデックス作成が完了するまでの間、新しく作成されたエンティティが検索結果に表示されない場合があります。 これは想定される動作です。 検索インデックスは、大規模なデータセット全体にわたるフィルタリング、ソート、ファセット検索、ページングに最適化されています。
対照的に、ID または 外部参照コード による単一エンティティの検索は、データベースに直接クエリを実行し、作成トランザクションがコミットされるとすぐにエンティティを返します。
エンティティを作成し、次のステップでそれを読み取ったりリンクしたりする場合は、フィルタリングされたクエリを使用する代わりに、IDまたは外部参照コードを使用して取得してください。 例えば、製品を作成した後、 GET /o/headless-commerce-admin-catalog/v1.0/products/by-externalReferenceCode/{externalReferenceCode} を使用して取得します。 エンティティを作成する際に外部参照コードを割り当てるため、この読み取りは即座に行われ、予測可能です。
データ移行センター
Liferayのデータ移行センターは、Liferayインスタンス間のデータ転送を効率化します。 システムのアップグレード、環境の統合、または新しいプラットフォームへのデータ移行など、どのような場合でも、この機能はプロセスを簡素化します。 オブジェクト定義とエントリをエクスポートおよびインポートすることで、組織は手動操作なしにコンテンツ、構成、およびユーザーデータを移動できます。 この自動化により、エラーが減り、時間が節約され、データの整合性が確保されます。
バッチエンジンAPI - データのインポートとエクスポート
Liferayのヘッドレスバッチエンジンは、データのインポートやエクスポートを行うためのREST APIを提供します。 これらのAPIはCSV、JSON、XLSX形式をサポートしており、大規模なデータセットにも対応可能です。 さらに、一部のAPIはエクスポート時にデータをフィルタリングすることができます。 上級ユーザー向けには、インポートおよびエクスポート処理をコードでカスタマイズする機能が用意されています。
バッチエンジンを使用すると、異なるシステム間またはLiferayインスタンス間で大量のデータを転送したり、外部ソースからデータをインポートしたり、他のアプリケーションで使用するためにデータをエクスポートしたりすることで、Liferayを他のシステムと統合したり、レポート作成や分析に適した形式でデータをエクスポートしたりできます。
Liferay 2026.Q1+ では、 LAR エクスポートとインポート もバッチ フレームワークを使用して、サイト スコープとインスタンス スコープで多くの種類のエンティティを処理します。 ワークフローに適しているのであれば、LARファイルを使ったコンテンツのプロモーションも検討してみてください。
外部参照コードの使用
外部参照コード （ERC）を使用すると、異なるシステム間でのデータ同期とマッピングが簡単に行えます。 共通の参照点を用いることで、プラットフォーム間でデータを一貫して転送および更新することが可能になる。 データ移行プロセス中、ERC（エンタープライズレコード）を使用すると、移行前後のレコードを追跡および照合したり、データ変更の履歴を追跡したり、以前のデータを追跡したりできます。
APIを介して外部システムやデータベースとやり取りする場合、ERCはレコードの一意の識別子として機能し、データの同期とマッピングを容易にします。
つまり、Liferayはユーザーインターフェース以外でもデータを操作するためのツール一式を提供しているということだ。 さらに詳しく知りたい方は、続きをお読みください。