*API

Amelia で API 機能を使用する方法

Amelia の API 機能を使用すると、外部システムが安全で構造化されたリクエストを通じて、インストールされている Amelia と通信できるようになります。これにより、開発者はカスタム連携の構築、データの同期、ワークフローの自動化、および標準のインターフェースを超えた Amelia の拡張が可能になります。このセクションで利用可能な API ツールは、アクセスを有効にし、安全なキーを生成し、開発に必要なベース URL を提供することに焦点を当てています。

API 機能はどこで有効にできますか？

API 機能は、「機能と連携」メニュー内の「機能」セクションで有効にできます。

有効にすると「設定」ボタンが表示され、API キーの生成と管理を行うための設定画面が開きます。

API 設定画面にはどのような情報が表示されますか？

設定画面には、外部アプリケーションを認証して接続するために必要なすべての情報が表示されます。

• API ベース URL – すべての API 呼び出しで使用されるエンドポイントのルートです。外部システムは Amelia とやり取りするために、このアドレスを使用する必要があります。
• 有効期限 – 生成された API キーが有効である期間を設定します。選択肢には、1年、2年、3年、および無制限があります。
• 生成ボタン – 選択した有効期限を使用して、新しい API キーを作成します。
• お客様の API キー項目 – 新しく作成されたキーを一度だけ表示します。キーが保存された後は、セキュリティ上の理由から非表示になります。
• API キーリスト – 以前に作成されたすべてのキーを、有効期限と削除アクションとともに表示します。

すべての API キーは、このページのみで管理されます。

API キーは生成時に一度だけ表示されます。保存をクリックする前に、すぐにコピーしてください。再度表示されることはありません。

API キーはどのように機能しますか？

API キーは Amelia のエンドポイントへのアクセスを許可するもので、すべてのリクエストに含まれている必要があります。すべてのエンドポイントは、「Amelia」という名前のヘッダーに API キーの値を保持する、ヘッダーベースの認証を使用します。

キーは有効期限を限定して、または無制限に生成できるため、セキュリティ向上のためにアクセス期間を制御できます。恒久的なアクセスが必要な場合を除き、短い有効期限を設定することをお勧めします。

Amelia の API パスは何ですか？

すべての Amelia API リクエストは、以下のベース構造から始まります。

{{your_site_URL}}/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1

開発者は、アクセスしたいデータの種類やアクションに応じて、このベース URL に追加のエンドポイントを付加します。

サポートされているエンドポイントの一覧はどこにありますか？

リクエストとレスポンスの例を含む、利用可能な API エンドポイントの完全なリストは、ダウンロード可能な Postman コレクションで提供されています。

このコレクションには、以下の例が含まれています。

• 会計
• 予約
• 予約
• エンティティ
• 時間枠の検索
• クーポン

これは、サポートされているすべてのリクエストタイプについて、開発者に完全なリファレンスを提供することを目的としています。

Postman アプリケーションをまだお持ちでない場合は、無料のアカウントを作成し、Windows、macOS、または Linux 用にダウンロードできます。

Amelia API の使用について、どこで詳しく学べますか？

詳細な技術手順、エンドポイントの使用法、認証の例、および連携のサンプルについては、「開発者向け」ドキュメントカテゴリーを参照してください。このセクションでは、すべての API 機能を詳細に説明しています。