操作ガイド
APIエンドポイントとAPIキー
APIエンドポイントを使用すると、外部システムからプラグインのアクションを呼び出すことができます。これらのエンドポイントは、API内でリクエストを受け付け、レスポンスを提供する指定された場所です。これらは、指定されたアクセスポイントを通じて情報や指示の交換を可能にすることで、多様なシステムおよびアプリケーション間の通信を促進します。
APIエンドポイントは、API（アプリケーション・プログラミング・インターフェース）を介してAmeliaと連携する必要がある開発者やソフトウェアアプリケーション向けに設計されています。これらは、外部システムが構造化され標準化された方法でシステムと通信するためのアクセスポイントまたはURLとして機能します。
APIエンドポイントが不可欠な理由：
- 開発者とプログラマー： Ameliaが提供するデータ、サービス、または機能にアクセスする必要があるソフトウェアアプリケーションを構築する開発者やプログラマーが使用します。彼らはAPIエンドポイントを使用して、構造化され標準化された方法でそのシステムと通信します。
- 相互運用性： APIエンドポイントは、異なるソフトウェアシステム間の相互運用性を可能にします。これにより、アプリケーションは互いの内部詳細を知る必要なく、連携してデータやサービスを共有できます。
- データとサービスへのアクセス： APIエンドポイントは、システムのデータまたはサービスへの制御されたアクセスを提供します。たとえば、ECサイトには、サードパーティアプリケーションがサービス情報を取得したり、予約や決済を処理したり、お客様データを安全に取得したりできるようにするAPIエンドポイントがある場合があります。
- 標準化された通信： これらは、HTTPメソッド（GET、POST、PUT、DELETE）、リクエストおよびレスポンスの形式（通常はJSONまたはXML）、認証方法など、通信のための一連のルールとプロトコルを設定します。この標準化により、システム間で一貫した信頼性の高い通信が保証されます。
- セキュリティと認証： APIエンドポイントには、機密データやサービスを保護するために、認証や認可メカニズムなどのセキュリティ対策が含まれていることがよくあります。
- スケーラビリティ： APIエンドポイントは、追加のアプリケーションやサービスがその機能にアクセスするための制御された方法を提供することにより、システムの拡張と成長を可能にします。
認証
すべてのAmeliaエンドポイントは、ヘッダープロパティ「Amelia」を使用したAPIキー認証を利用します。
パス
Amelia APIのパスは、次の形式で始まります。
{{your_site_URL}}/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1
AmeliaエンドポイントのAPIキーは、「Amelia」＞「設定」＞「APIキー」で管理できます。
「APIキーの設定を確認する」をクリックすると、右側に編集画面が表示され、APIキーの生成(1)、コピー(2)、削除(3)、有効期限の設定(4)、およびこちらからPostmanコレクションのダウンロードを行うことができます。
APIキーを生成する際に、有効期限を選択できるようになりました。
- 1年
- 2年
- 3年
- 無期限
これにより、キーの有効期間を制御できます。セキュリティを向上させるため、永続的に保持する特別な理由がない限り、キーの期間を短く制限することをお勧めします。
Ameliaはセキュリティ上の目的からAPIキーを非表示にするため、「保存」をクリックする前にコピーする必要があります。再度表示されることはありません。
Postmanコレクションをまだお持ちでない場合は、ここで無料でサインアップして、Windows、Linux、Mac用のネイティブアプリをダウンロードできます。
「Amelia」＞「設定」からダウンロードしたコレクションには、決済、予約、エンティティ、検索、時間枠、クーポンの例が含まれています。