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

リージョンAPIの基礎

Liferay 7.4 U24+ および GA24+

Liferay の REST API を使用してリージョンを作成および管理します。

リージョンの追加

新しいLiferay DXPインスタンスを起動し、以下を実行します。

docker run -it -m 8g -p 8080:8080 liferay/dxp:2025.q1.6-lts

メールアドレス test@liferay.com とパスワード testを使用して、 http://localhost:8080 で Liferay にサインインします。 プロンプトが表示されたら、パスワードを learnに変更します。

次に、以下の手順に従います。

  1. Regions API Basicsをダウンロードして解凍します。

    curl https://resources.learn.liferay.com/examples/liferay-r2p3.zip -O

    unzip liferay-r2p3.zip

  2. cURL スクリプトを使用して、国に新しい地域を追加します。 コマンドラインで、curlフォルダに移動します。 Regions_POST_ToCountry.sh スクリプトを実行します。

    ./Regions_POST_ToCountry.sh 1234

    1234 を国IDに置き換えます。 ID のリストを取得するには、 インスタンスから国を取得 を使用します。

    JSON 応答には、新しいリージョンが追加されたことが示されています。

    {
  "active" : true,
  "countryId" : 43501,
  "id" : 43503,
  "name" : "Foo",
  "position" : 0.0,
  "regionCode" : "ABL",
  "title_i18n" : { }
}

  3. RESTサービスは、Javaクライアントを使って呼び出すこともできます。 curl フォルダから、 java フォルダに移動します。 ソースファイルをコンパイルします。

    javac -classpath .:* *.java

  4. Regions_POST_ToCountry.java クラスを実行します。

    java -classpath .:* -DcountryId=1234 Regions_POST_ToCountry

cURLコマンドの検証

Regions_POST_ToCountry.sh スクリプトは、cURL コマンドを使用して REST サービスを呼び出します。

curl \
	"http://localhost:8080/o/headless-admin-address/v1.0/countries/${1}/regions" \
	--data-raw '
		{
			"name": "Foo",
			"regionCode": "ABL"
		}' \
	--header "Content-Type: application/json" \
	--request "POST" \
	--user "test@liferay.com:learn"

ここでは、コマンドの引数を紹介します。

引数説明
-H "Content-Type: application/json"リクエストボディのフォーマットがJSONであることを示します。
-X POST指定されたエンドポイントで起動するHTTPメソッド
"http://localhost:8080/o/headless-admin-address/v1.0/countries/${1}/regions"RESTサービスのエンドポイント
-d "{\"name\": \"Foo\", \"regionCode\": \"ABL\"}"お客様が掲載を希望するデータ
-u "test@liferay.com:learn"基本的な認証情報
注

ここでは、デモのために基本的な認証を使用しています。 本番環境では、 OAuth2経由でユーザーを認証する必要があります。 OAuth2 を使用するサンプル React アプリケーションについては、 OAuth2 を使用してユーザーを承認する を参照してください。

他のcURLコマンドも同様のJSON引数を使用しています。

Javaクラスを調べる

Regions_POST_ToCountry.java クラスは、Region 関連のサービスを呼び出してリージョンを追加します。

public static void main(String[] args) throws Exception {
	RegionResource.Builder builder = RegionResource.builder();

	RegionResource regionResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	Region region = regionResource.postCountryRegion(
		Long.valueOf(System.getProperty("countryId")),
		new Region() {
			{
				name = "Foo";
				regionCode = "ABL";
			}
		});

	System.out.println(region);
}

このクラスは、わずか3行のコードでRESTサービスを呼び出します。

行（省略形）説明
RegionResource.Builder builder = ...Builder を取得して、 RegionResource サービス インスタンスを生成します。
RegionResource regionResource = builder.authentication(...).build();基本認証を指定し、 RegionResource サービス インスタンスを生成します。
Region region = regionResource.postRegion(...);regionResource.postRegion メソッドを呼び出し、データを post に渡します。

プロジェクトには、依存関係としてcom.liferay.headless.admin.address.client.jarファイルが含まれていることに注意してください。 すべてのRESTアプリケーションのクライアントJAR依存関係情報は、/o/apiでインストール先のAPIエクスプローラーで確認できます。

注

メイン メソッドのコメントは、クラスの実行を示しています。

他の Java クラスの例もこれに似ていますが、異なる RegionResource メソッドを呼び出します。

重要

サービスの詳細については、 RegionResource を参照してください。

以下は、cURL と Java を使用して他の リージョン REST サービスを呼び出す例です。

インスタンスからリージョンを取得する

次の cURL または Java コマンドを実行すると、リージョンを一覧表示できます。

Regions_GET_FromInstance.sh

コマンド：

./Regions_GET_FromInstance.sh

コード：

curl \
	"http://localhost:8080/o/headless-admin-address/v1.0/regions" \
	--user "test@liferay.com:learn"

Regions_GET_FromInstance.java

コマンド:

java -classpath .:* Regions_GET_FromInstance

コード:

public static void main(String[] args) throws Exception {
	RegionResource.Builder builder = RegionResource.builder();

	RegionResource regionResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	Page<Region> page = regionResource.getRegionsPage(
		null, null, Pagination.of(1, 2), null);

	System.out.println(page);
}

インスタンスの リージョン オブジェクトが JSON に表示されます。

地域を取得する

次の cURL または Java コマンドを使用して特定のリージョンを取得します。

ヒント

Regions_GET_FromInstance.[java|sh] を使用して、インスタンス Region ID を取得します。

Regions_GET_ById.sh

コマンド：

./Regions_GET_ById.sh 1234

コード：

curl \
	"http://localhost:8080/o/headless-admin-address/v1.0/regions/${1}" \
	--user "test@liferay.com:learn"

Regions_GET_ById.java

コマンド：

java -classpath .:* -DregionId=1234 Regions_GET_ById

コード：

public static void main(String[] args) throws Exception {
	RegionResource.Builder builder = RegionResource.builder();

	RegionResource regionResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		regionResource.getRegion(
			Long.valueOf(System.getProperty("regionId"))));
}

Region フィールドが JSON に表示されます。

領域をパッチする

次の cURL および Java コマンドを使用して、既存のリージョンの部分的な編集を行います。 1234 をリージョンの ID に置き換えます。

Regions_PATCH_ById.sh

コマンド：

./Regions_PATCH_ById.sh 1234

コード：

curl \
	"http://localhost:8080/o/headless-admin-address/v1.0/regions/${1}" \
	--data-raw '
		{
			"name": "Bar"
		}' \
	--header "Content-Type: application/json" \
	--request "PATCH" \
	--user "test@liferay.com:learn"

Regions_PATCH_ById.java

コマンド：

java -classpath .:* -DregionId=1234 Regions_PATCH_ById

コード：

public static void main(String[] args) throws Exception {
	RegionResource.Builder builder = RegionResource.builder();

	RegionResource regionResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	Region region = regionResource.patchRegion(
		Long.valueOf(System.getProperty("regionId")),
		new Region() {
			{
				name = "Bar";
			}
		});

	System.out.println(region);
}

地域を設定する

次の cURL および Java コマンドを使用して、既存のリージョンを完全に上書きします。 1234 を地域の ID に置き換えます。

Regions_PUT_ById.sh

コマンド：

./Regions_PUT_ById.sh 1234

コード：

curl \
	"http://localhost:8080/o/headless-admin-address/v1.0/regions/${1}" \
	--data-raw '
		{
			"name": "Goo",
			"regionCode": "ABL"
		}' \
	--header "Content-Type: application/json" \
	--request "PUT" \
	--user "test@liferay.com:learn"

Regions_PUT_ById.java

コマンド:

java -classpath .:* -DregionId=1234 Regions_PUT_ById

コード：

public static void main(String[] args) throws Exception {
	RegionResource.Builder builder = RegionResource.builder();

	RegionResource regionResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	Region region = regionResource.putRegion(
		Long.valueOf(System.getProperty("regionId")),
		new Region() {
			{
				name = "Goo";
				regionCode = "ABL";
			}
		});

	System.out.println(region);
}

リージョンを削除する

次の cURL および Java コマンドを使用して、既存のリージョンを削除します。 1234 を地域の ID に置き換えます。

Regions_DELETE_ById.sh

コマンド：

./Regions_DELETE_ById.sh 1234

コード:

curl \
	"http://localhost:8080/o/headless-admin-address/v1.0/regions/${1}" \
	--request "DELETE" \
	--user "test@liferay.com:learn"

Regions_DELETE_ById.java

コマンド

java -classpath .:* -DregionId=1234 Regions_DELETE_ById

コード:

public static void main(String[] args) throws Exception {
	RegionResource.Builder builder = RegionResource.builder();

	RegionResource regionResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	regionResource.deleteRegion(
		Long.valueOf(System.getProperty("regionId")));
}

API エクスプローラー には、すべての リージョン サービスとスキーマが表示され、各サービスを試すためのインターフェースがあります。

Capability:
Development and Tooling
Resource Type:
Official Documentation
Feature:
Data Frameworks
Deployment Approach:
Liferay PaaS
Liferay Self-Hosted