この記事では、Gelato API を使って Webhook を設定し、注文にイベントが発生したときにアプリで通知を受け取る方法を説明します。
Webhookの設定
Gelato API には強力な Webhook 機能があり、注文に関する重要なイベントを逃さず把握できます。Webhook を設定するには、次の手順に従ってください。
Gelatoのダッシュボードにアクセスし、Webhooksセクションに進もう。ここはwebhookの設定をまとめて管理できる専用エリアだよ。
「Add Webhook」ボタンをクリックして、新しい Webhook の作成を始めよう。クリックすると設定フォームが表示され、Webhook の詳細を指定できるよ。
アプリでWebhook通知を受け取るエンドポイントのURLを入力してください。外部からアクセスでき、受信したHTTPリクエストを適切に処理できるよう設定されていることを確認しましょう。HTTPメソッドは、アプリの要件に合わせてGETかPOSTを選びます。購読したいイベントタイプも選択してください。Gelatoでは、注文作成、注文更新、出荷通知など、受け取る通知を細かくコントロールできる包括的なイベントタイプ一覧を用意しています。各イベントタイプの詳しい説明は、APIドキュメントを参照してください。
Webhookの認可を設定してセキュリティを強化し、通知が信頼できる送信元から届くことを確認しましょう。まずは認可方式を選びます。HTTPヘッダーやクエリパラメータなど、用途に合うタイプを選択してください。続いて、APIキーやトークンなどの必要な認証情報を指定された欄に入力します。設定を確認し、通知が正しく届くかを確かめるために、指定したエンドポイントへテスト通知を送信しましょう。この手順で、本番環境にWebhookをデプロイする前に、潜在的な問題を見つけて解決できます。
Webhook の管理
Webhookの設定が完了したら、Gelatoのダッシュボードからかんたんに管理できます。Webhooksセクションでは、すべてのWebhookをひと目で確認でき、次のような操作が行えます。
既存のWebhookの編集:ニーズの変化に合わせて、いつでもWebhookの設定を変更できます。通知URL、イベント購読、認可の詳細などを必要に応じて更新しましょう。
Webhookの削除:不要になったWebhookを削除して、Webhook設定をすっきり整理しましょう。Webhookを削除すると、関連付けられたエンドポイントへの通知送信が停止します。
Gelato API をさらに深く理解するには、Webhook のイベントやペイロードの詳細情報を含む、充実した技術ドキュメントを参照してください。
GelatoアカウントでWebhookセクションにアクセスするには、左側メニューからDeveloper > Webhooksに直接移動できます。


