MENU

料金プラン

機能一覧

デモ

ご利用の流れ

お役立ちコラム



WordPressユーザー

操作ガイド

Amelia API – WordPressユーザー

ここでは、WordPressユーザーに関連するAPIエンドポイントをご覧いただけます。

すべてのAPIエンドポイントと、リクエストおよびレスポンスの例は、こちらからダウンロードできるAmelia API Postmanコレクションで確認できます。

APIエンドポイントの使用には、一定のコーディングスキルが必要であり、プラグインで提供されるサポートには含まれていません。

認証

すべてのAmeliaエンドポイントは、Ameliaという名前のヘッダープロパティを使用したAPIキー認証を採用しています。

パス

Amelia APIのパスは以下で始まります:{{your_site_URL}}/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1

WPユーザーの取得

Ameliaお客様またはスタッフに紐付けられていないWordPressユーザーを取得します。これは、新しいAmeliaユーザーをWordPressユーザーに接続するために使用されます。

メソッド

このエンドポイントはGETリクエストを受け付けます。

パス

/users/wp-users

オプションのプロパティ

結果をフィルタリングするために、以下のクエリパラメータを使用できます。

キータイプ説明
rolestring取得するWordPressユーザーのロール。使用可能な値:customerAmelia お客様)、providerAmelia スタッフ

リクエスト
curl --location 'http://localhost/amelia/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/users/wp-users' \
--header 'Amelia: qUmkNNOLrWbf28izIgNnZ29O+7gVWL5M+8ySJ8VXq3r0'
レスポンス
{
"message": "Successfully retrieved users.",
"data": {
"users": [
{
"value": 2,
"label": "snakemilicayahoo-com"
},
{
"value": 35,
"label": "Amelia"
}
]
}
}