

操作ガイド
ここでは、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
Ameliaのお客様またはスタッフに紐付けられていないWordPressユーザーを取得します。これは、新しいAmeliaユーザーをWordPressユーザーに接続するために使用されます。
メソッド
このエンドポイントはGETリクエストを受け付けます。
パス
/users/wp-users
オプションのプロパティ
結果をフィルタリングするために、以下のクエリパラメータを使用できます。
| キー | タイプ | 説明 |
role | string | 取得するWordPressユーザーのロール。使用可能な値:customer(Amelia お客様)、provider(Amelia スタッフ) |
例:
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"
}
]
}
}