住所APIの基本

liferay DXP/Portal 7.4+.

Liferay の REST API を使用して郵便住所を管理します。

アカウントに住所を追加する

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

docker run -it -m 8g -p 8080:8080 liferay/dxp:2024.q1.1。

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

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

Postal Address API Basics をダウンロードして解凍する。

curl https://resources.learn.liferay.com/dxp/latest/en/users-and-permissions/developer-guide/liferay-n8y7.zip -O

unzip liferay-n8y7.zip

アカウントのリストを取得するには、 Accounts_GET_FromInstance を使用します。住所を追加するアカウントのIDをメモしてください。また、 Global Menu → Control Panel → Accounts に移動してアカウントのリストを見ることもできます。

cURLスクリプトを使用して、選択したアカウントに新しい住所を追加します。コマンドラインで curl フォルダに移動します。 PostalAddress_POST_ToAccount.shスクリプトを実行する。 1234をアカウントIDに置き換える。

./PostalAddress_POST_ToAccount.sh 1234

JSONレスポンスは、新しい住所が追加されたことを示しています：

 {
   "addressCountry" : "United States",
   "addressLocality" : "Diamond Bar",
   "addressRegion" : "California",
   "addressType" : "shipping",
   "id" : 35706,
   "name" : "Able Address",
   "postalCode" : "12345",
   "primary" : false,
   "streetAddressLine1" : "123 Foo St",
   "streetAddressLine2" : "",
   "streetAddressLine3" : ""
 }

Global Menu → Control Panel → Accounts に移動します。ステップ2で選択したアカウントを選択し、 Addresses に移動します。アカウントに新しい住所が追加されていることを確認してください。
RESTサービスは、Javaクライアントを使って呼び出すこともできます。 curlフォルダからjava フォルダに移動します。ソースファイルをコンパイルします。
```
javac -classpath .:* *.java
```
PostalAddress_POST_ToAccount.javaクラスを実行する。 1234をアカウントIDに置き換える。
```
java -classpath .:* -DaccountId=1234 PostalAddress_POST_ToAccount
```

cURLコマンドの検証

PostalAddress_POST_ToAccount.shスクリプトはcURLコマンドでRESTサービスを呼び出す。

curl \
	"http://localhost:8080/o/headless-admin-user/v1.0/accounts/${1}/postal-addresses" \
	--data-raw '
		{
			"addressCountry": "United States",
			"addressLocality": "Diamond Bar",
			"addressRegion": "California",
			"addressType": "shipping",
			"name": "Able Address",
			"postalCode": "12345",
			"primary": false,
			"streetAddressLine1": "123 Foo St",
			"streetAddressLine2": "",
			"streetAddressLine3": ""
		}' \
	--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-user/v1.0/accounts/${1}/postal-addresses"`	RESTサービスのエンドポイント
`-d "{\"addressCountry\": \"United States\", \"addressLocality\": \"Diamond Bar\", \"addressRegion\": \"California\", \"addressType\": \"shipping\", \"name\": \"Able Address\", \"postalCode\": \"12345\", \"primary\": false, \"streetAddressLine1\": \"123 Foo St\", \"streetAddressLine2\": \"\", \"streetAddressLine3\": \"\"}"`	お客様が掲載を希望するデータ
`-u "test@liferay.com:learn"`	基本的な認証情報

Note

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

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

Javaクラスを調べる

PostalAddress_POST_ToAccount.javaクラスは、郵便住所関連サービスを呼び出して郵便住所を追加する。

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

行（省略形）	説明
`PostalAddress.Builder builder = ...`	`PostalAddressResource`サービスインスタンスを生成するための`Builder` を取得する。
`PostalAddressResource postalAddressResource = builder.authentication(...).build();`	基本認証を指定し、`PostalAddressResource` サービスインスタンスを生成する。
`PostalAddress postalAddress = postalAddressResource.postAccountPostalAddress(...);`	`postalAddressResource.postAccountPostalAddress`メソッドを呼び出し、データをpostに渡す。

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

Note

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

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

Important

サービスの詳細は PostalAddressResource を参照のこと。

以下は、cURLとJavaを使って他のPostalAddress RESTサービスを呼び出す例である。

アカウントから住所を取得する

以下のcURLまたはJavaコマンドを使用して、アカウントから郵便住所のリストを取得する。 1234`をアカウントIDに置き換える。

PostalAddresses_GET_FromAccount.sh

コマンド：

./PostalAddresses_GET_FromAccount.sh 1234

コード：

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

PostalAddresses_GET_FromAccount.java

コマンド：

java -classpath .:* -DaccountId=1234 PostalAddresses_GET_FromAccount

コード：

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

	PostalAddressResource postalAddressResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		postalAddressResource.getAccountPostalAddressesPage(
			Long.valueOf(System.getProperty("accountId"))));
}

アカウントの郵便住所はJSONレスポンスで返される。

組織から住所を取得する

以下のcURLまたはJavaコマンドを使って、ある組織から郵便住所のリストを取得する。 1234を組織のIDに置き換えてください。

PostalAddresses_GET_FromOrganization.sh

コマンド：

./PostalAddresses_GET_FromOrganization.sh 1234

コード：

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

PostalAddresses_GET_FromOrganization.java

コマンド：

java -classpath .:* -DorganizationId=1234 PostalAddresses_GET_FromOrganization

コード：

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

	PostalAddressResource postalAddressResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		postalAddressResource.getOrganizationPostalAddressesPage(
			String.valueOf(System.getProperty("organizationId"))));
}

組織の郵便住所がJSONレスポンスで返される。

ユーザーから住所を取得する

以下のcURLまたはJavaコマンドで、ユーザーから郵便住所のリストを取得する。 1234をユーザーIDに置き換える。

PostalAddresses_GET_FromUser.sh

コマンド：

./PostalAddresses_GET_FromUser.sh 1234

コード：

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

PostalAddresses_GET_FromUser.java

コマンド：

java -classpath .:* -DuserAccountId=1234 PostalAddresses_GET_FromUser

コード：

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

	PostalAddressResource postalAddressResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		postalAddressResource.getUserAccountPostalAddressesPage(
			Long.valueOf(System.getProperty("userAccountId"))));
}

ユーザーの住所はJSONレスポンスで返される。

住所の取得

以下のcURLまたはJavaコマンドで特定の郵便住所を取得する。 1234`を郵便住所のIDに置き換える。

Tip

PostalAddress_GET_FromAccount.[java|sh] を使用して、アカウントの 郵便住所 ID を取得します。

組織の郵便番号IDを取得するには PostalAddress_GET_FromOrganization.[java|sh] を使用してください。

ユーザーの 郵便住所 ID を取得するには PostalAddress_GET_FromUser.[java|sh] を使用してください。

PostalAddress_GET_ById.sh

コマンド：

./PostalAddress_GET_ById.sh 1234

コード：

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

PostalAddress_GET_ById.java

コマンド：

java -classpath .:* -DpostalAddressId=1234 PostalAddress_GET_ById

コード：

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

	PostalAddressResource postalAddressResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		postalAddressResource.getPostalAddress(
			Long.valueOf(System.getProperty("postalAddressId"))));
}

郵便番号はJSONレスポンスで返される。

住所をパッチする

以下のcURLまたはJavaコマンドを使って、既存の郵便住所を部分的に編集する。 1234を郵便住所のIDに置き換える。

PostalAddress_PATCH_ById.sh

コマンド：

./PostalAddress_PATCH_ById.sh 1234

コード：

PostalAddress_PATCH_ById.java

コマンド：

java -classpath .:* -DpostalAddressId=1234 PostalAddress_PATCH_ById

コード：

住所を記入する

以下のcURLまたはJavaコマンドで、既存の郵便住所を完全に上書きする。 1234を郵便住所のIDに置き換える。

PostalAddress_PUT_ById.sh

コマンド：

./PostalAddress_PUT_ById.sh 1234

コード：

PostalAddress_PUT_ById.java

コマンド：

java -classpath .:* -DpostalAddressId=1234 PostalAddress_PUT_ById

コード：

住所を削除する

以下のcURLまたはJavaコマンドを使用して、既存の郵便住所を削除する。 1234を郵便住所のIDに置き換える。

PostalAddress_DELETE_ById.sh

コマンド：

./PostalAddress_DELETE_ById.sh 1234

コード：

PostalAddress_DELETE_ById.java

コマンド：

java -classpath .:* -DpostalAddressId=1234 PostalAddress_DELETE_ById

コード：

API Explorer はすべての PostalAddress サービスとスキーマを表示し、各サービスを試すためのインターフェイスを持っています。

Capability:

Development and Tooling

Deployment Approach:

Liferay PaaS

Liferay Self-Hosted

Feature:

Data Frameworks

Cloud

Commerce

Content Management System

Development and Tooling

Digital Asset Management

DXP Self-Hosted Installation, Maintenance, and Administration

Integration

Personalization

Platform

Search

Security

Sites

Analytics Cloud

Commerce

DXP

Liferay Cloud

Reference