Documentation

Accounts APIの基本

アプリケーションメニューから アカウント を管理することができますが、LiferayのREST APIを利用することもできます。 これらのサービスを呼び出して、アカウントの作成や管理を行います。

アカウントの追加

新しいLiferayインスタンスを実行します。

docker run -it -m 8g -p 8080:8080 liferay/dxp:7.4.13-u22

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

次に、以下の手順を実行します。

  1. ダウンロードして解凍する Accounts API Basics

    curl https://learn.liferay.com/dxp/latest/ja/users-and-permissions/developer-guide/liferay-t5p9.zip -O
    
    unzip liferay-t5p9.zip
    
  2. cURLスクリプトを使用して、インスタンスに新しいAccountを追加します。 コマンドラインで、 curl フォルダに移動します。 Account_POST_ToInstance.sh スクリプトを実行します。

    ./Account **POST** ToInstance.sh
    

    JSONレスポンスでは、新しいAccountが追加されたことを示しています。

    "description" : "Foo",
    "domains" : [ ],
    "externalReferenceCode" : "",
    "id" : 39302,
    "name" : "Able",
    "numberOfUsers" : 0,
    "organizationIds" : [ ],
    "parentAccountId" : 0,
    "status" : 0,
    "type" : "business"
    
  3. グローバルメニュー] → [アプリケーション] → [アカウント] に移動します。 新しいアカウントが追加されたことを確認してください。

    新しいアカウントが追加されたことを確認します。

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

    javac -classpath .: *** .java
    
  5. Account_POST_ToInstance.java クラスを以下のコマンドで実行します。

    java -classpath .: **Account***POST** ToInstance
    

cURLコマンドの検証

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

curl \
	-H "Content-Type: application/json" \
	-X POST \
	"http://localhost:8080/o/headless-admin-user/v1.0/accounts" \
	-d "{\"description\": \"Foo\", \"name\": \"Able\"}" \
	-u "[email protected]:learn"

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

引数

説明

-H "Content-Type: application/json"

リクエストボディのフォーマットがJSONであることを示す。

-X POST

指定されたエンドポイントで起動するHTTPメソッド

"http://localhost:8080/o/headless-admin-user/v1.0/accounts"

RESTサービスのエンドポイント

-d "{\"description\": \"Foo\", \"name\": \"Able\"}"

投稿をリクエストしているデータ

-u "test@liferay.com:learn"

基本的な認証情報

注釈

ここでは、デモのためにベーシック認証を使用しています。 本番環境では、 OAuth2でユーザーを認証する必要があります。

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

Javaクラスを調べる

Account_POST_ToInstance.java クラスは、Account関連のサービスを呼び出してアカウントを追加します。

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

	AccountResource accountResource = builder.authentication(
		"[email protected]", "learn"
	).build();

	Account account = accountResource.postAccount(
		new Account() {
			{
				description = "Foo";
				name = "Fox";
			}
		});

	System.out.println(account);
}

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

行(省略形)

説明

AccountResource.Builder builder = ...

AccountResourcサービスインスタンスを生成するためのBuilderを取得します。

AccountResource accountResource = builder.authentication(...).build();

ベーシック認証を指定し、 AccountResource サービスインスタンスを生成します。

Account account = accountResource.postAccount(...);

accountResource.postAccount メソッドを呼び出し、データをpostに渡します。

注釈

main`メソッドのコメントでは、クラスの実行を実演しています。

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

重要

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

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

インスタンスからアカウントを取得

以下のcURLまたはJavaコマンドを実行することで、アカウントを一覧表示することができます。

Accounts GET FromInstance.sh

コマンド:

./Accounts_GET_FromInstance.sh

Code:

curl \
	"http://localhost:8080/o/headless-admin-user/v1.0/accounts" \
	-u "[email protected]:learn"

Accounts GET FromInstance.java

コマンド:

java -classpath .:* Accounts_GET_FromInstance

Code:

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

	AccountResource accountResource = builder.authentication(
		"[email protected]", "learn"
	).build();

	Page<Account> page = accountResource.getAccountsPage(
		null, null, Pagination.of(1, 2), null);

	System.out.println(page);
}

インスタンスの アカウント オブジェクトがJSONで表示されます。

アカウントの取得

以下のcURLまたはJavaコマンドで特定のアカウントを取得します。

ちなみに

インスタンスのアカウントIDを取得するには、Accounts_GET_FromInstance.[java|sh]を使用します。

Account GET ById.sh

コマンド:

./Account_GET_ById.sh 1234

Code:

curl \
	"http://localhost:8080/o/headless-admin-user/v1.0/accounts/${1}" \
	-u "[email protected]:learn"

Account GET ById.java

コマンド:

java -classpath .:* -DaccountId=1234 Account_GET_ById

Code:

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

	AccountResource accountResource = builder.authentication(
		"[email protected]", "learn"
	).build();

	Account account = accountResource.getAccount(
		Long.valueOf(System.getProperty("accountId")));

	System.out.println(account);
}

アカウント フィールドはJSONで表示されます。

アカウントへのパッチ適用

以下のcURLおよびJavaコマンドで、既存のAccountの部分編集を行います。 なお、 1234 は、アカウントのIDに置き換えてください。

Account PATCH ById.sh

コマンド:

./Account_PATCH_ById.sh 1234

Code:

curl \
	-H "Content-Type: application/json" \
	-X PATCH \
	"http://localhost:8080/o/headless-admin-user/v1.0/accounts/${1}" \
	-d "{\"description\": \"Bar\"}" \
	-u "[email protected]:learn"

Account PATCH ById.java

コマンド:

java -classpath .:* -DaccountId=1234 Account_PATCH_ById

Code:

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

	AccountResource accountResource = builder.authentication(
		"[email protected]", "learn"
	).build();

	Account account = accountResource.patchAccount(
		Long.valueOf(System.getProperty("accountId")),
		new Account() {
			{
				description = "Bar";
			}
		});

	System.out.println(account);
}

アカウントの作成

以下のcURLとJavaコマンドで、既存のAccountを完全に上書きします。 なお、 1234 は、アカウントのIDに置き換えてください。

Account PUT ById.sh

コマンド:

./Account_PUT_ById.sh 1234

Code:

curl \
	-H "Content-Type: application/json" \
	-X PUT \
	"http://localhost:8080/o/headless-admin-user/v1.0/accounts/${1}" \
	-d "{\"description\": \"Goo\", \"name\": \"Baker\"}" \
	-u "[email protected]:learn"

Account PUT ById.java

コマンド:

java -classpath .:* -DaccountId=1234 Account_PUT_ById

Code:

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

	AccountResource accountResource = builder.authentication(
		"[email protected]", "learn"
	).build();

	Account account = accountResource.putAccount(
		Long.valueOf(System.getProperty("accountId")),
		new Account() {
			{
				description = "Goo";
				name = "George";
			}
		});

	System.out.println(account);

アカウントの削除

以下のcURLおよびJavaコマンドで既存のAccountを削除します。 なお、 1234 は、アカウントのIDに置き換えてください。

Account DELETE ById.sh

コマンド:

./Account_DELETE_ById.sh 1234

Code:

curl \
	-X DELETE \
	"http://localhost:8080/o/headless-admin-user/v1.0/accounts/${1}" \
	-u "[email protected]:learn"

Account DELETE ById.java

コマンド

java -classpath .:* -DaccountId=1234 Account_DELETE_ById

Code:

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

	AccountResource accountResource = builder.authentication(
		"[email protected]", "learn"
	).build();

	accountResource.deleteAccount(
		Long.valueOf(System.getProperty("accountId")));
}

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