【Webhook（外部システムへの通知）】 – カラーミーショップ　ヘルプセンター

カラーミーショップで受注が作成されたときに、あらかじめ登録したURLへ自動で通知を送信する機能です。通知をきっかけに、ご自身で用意したシステムや、本機能に対応した外部のサービスがカラーミーショップの情報を取得できます。

このマニュアルは、APIや外部システムとの連携をすでにご利用の方に向けた内容です。

これまでは、外部のシステムが新しい受注がないかを定期的に確認しに行く必要がありました。本機能を利用すると、受注が入ったその場でカラーミーショップから通知が届くため、確認を待つ間のタイムラグがなくなります。

この仕組みは一般にWebhookと呼ばれます。外部のサービスや連携アプリの資料に「Webhook」と記載がある場合は、本機能が該当します。

仕様

利用の流れ

本機能は次の流れで利用します。

通知を受け取るシステム側で、通知先のURLを用意します。このURLは管理画面で発行されるものではありません。ご自身で用意するシステム、または本機能に対応した外部のサービスや連携アプリが発行します
用意したURLを、管理画面に通知先として登録します
受注が作成されると、カラーミーショップが登録されたURLへ通知を送信します
通知を受け取ったシステムが、カラーミーショップのAPIから受注の内容を取得して処理を進めます

できること

通知を送信するきっかけになる出来事を「イベント」と呼びます。登録したイベントが発生すると、通知先のURLへその場で通知を送信します。通知を受け取ったシステムは、その通知をきっかけにカラーミーショップのAPIから必要な情報を取得します。

本機能を利用するには、通知を受け取るシステム側の対応が必要です。通知を受け取るシステムは、ご自身で用意いただくか、本機能に対応した外部のサービスや連携アプリをご利用ください。

利用条件

フリープラン、およびカラーミーショップ for ロリポップ・for ヘテムル・for グーペをご利用の場合は、本機能を利用できません。

通知できるイベント

現在通知できるイベントは、受注が作成されたとき（管理画面上の表記は「受注したとき」）の1種類のみです。入金や発送、キャンセルのタイミングは対象外です。

通知先の登録内容

登録できる通知先：3件まで
URLの形式：httpsから始まるURL
イベント：現在は「受注したとき」のみ

登録した通知先のURLは、後から変更できません。変更する場合は、通知先を削除して登録し直します。

通知に含まれる情報

通知に含まれるのは、受注を識別するIDとショップを識別するIDです。注文者の氏名・住所・メールアドレスなどの情報は含まれません。

受注の内容は、通知を受け取った側がカラーミーショップのAPIから取得します。

署名検証用シークレット

通知先ごとに、署名検証用シークレットを発行します。届いた通知がカラーミーショップから送信されたものであることを、受け取った側が確認するために使う文字列です。【Webhook】ページでいつでも確認できます。

シークレットは、通知を受け取るシステムを実装する方にのみ共有してください。

ご利用にあたって

通知先には、ご自身で管理しているシステムのURLを登録することを推奨します
通知の送信が繰り返し失敗する通知先は、登録を削除する場合があります
送信した通知の履歴は、管理画面では確認できません
通知先へのテスト送信には対応していません
本機能およびAPIに関する技術的なサポートは行っておりませんため、受け取る側の実装はご自身または連携先のサービス提供元にてご対応いただく形となります

利用方法

通知先を登録する

設定 > 外部システム連携 > 【Webhook】を開きます
「追加」を選択します
イベント（「受注したとき」）を選択し、通知先のURLを入力します
「保存」を選択します

登録が完了すると一覧に戻ります。署名検証用シークレットは、一覧の「表示」で確認できます。

通知先のURLを変更する

登録した通知先のURLは変更できません。URLを変更する場合は、通知先を削除して、新しいURLで登録し直します。削除してから登録し直すまでの間に発生したイベントの通知は送信されません。

署名検証用シークレットを確認する

設定 > 外部システム連携 > 【Webhook】を開きます
確認する通知先の「表示」を選択します

「コピー」を選択すると、シークレットをコピーできます。

通知先を削除する

削除すると通知は停止されます。削除する直前に発生したイベントの通知は、タイミングによって届く場合があります。

設定 > 外部システム連携 > 【Webhook】を開きます
削除する通知先の「削除」を選択します
確認のメッセージが表示されるので「削除する」を選択します

通知を受け取るシステムを実装する

通知の形式や署名の検証方法は、【Webhook】通知を受け取るシステムを実装するをご覧ください。

活用のヒント

本機能は、受注をきっかけに動くシステムをご自身で用意して連携する利用を主に想定しています。本機能に対応した外部のサービスや連携アプリと組み合わせて利用することもできます。例えば、次のような場面で活用いただけます。

在庫管理や出荷代行のサービスと連携する

本機能を利用しない場合、在庫管理や出荷代行のサービス側が定期的に受注一覧を確認しに行くため、在庫の更新や出荷準備の着手までにタイムラグが生じます。本機能を利用すると、受注が入ったその場で通知が届き、それをきっかけに受注の情報が取得されるため、待ち時間なく在庫の更新や出荷準備に取りかかれます。

受注の状況をその場で把握・記録する

本機能を利用しない場合、受注メールを確認したり、管理画面にログインして確認する必要があります。対応する連携サービスと組み合わせると、受注が入ったその場でチャットツールへ通知が届いたり、表計算ソフトへ受注の情報が反映されたりといった活用が検討できます。

顧客管理システムへ受注データを反映する

本機能を利用しない場合、顧客管理システム側が新しい受注の有無を定期的に確認するため、反映されるまでにタイムラグが生じます。本機能を利用すると、受注が入ったその場で通知が届くため、確認を待たずに反映できます。

よくある質問

Q. 通知に注文者の氏名や住所は含まれますか？

含まれません。通知に含まれるのは、受注を識別するIDとショップを識別するIDです。受注の内容は、通知を受け取った側がカラーミーショップのAPIから取得します。

Q. 通知先のURLは管理画面で発行されますか？

発行されません。通知先のURLは、通知を受け取るシステム側で用意するものです。ご自身で用意するシステム、または本機能に対応した外部のサービスや連携アプリが発行したURLを、管理画面に登録してご利用ください。

Q. 通知先のURLを変更できますか？

変更できません。通知先を削除して、新しいURLで登録し直してください。

Q. どのプランで利用できますか？

フリープラン、およびカラーミーショップ for ロリポップ・for ヘテムル・for グーペ以外のプランでご利用いただけます。

Q. 受注の作成以外のイベントでも通知できますか？

現在通知できるイベントは、受注が作成されたタイミングのみです。

Q. 通知が届かないときはどうすればよいですか？

次の点をご確認ください。

登録したURLがhttpsから始まっているか
登録したURLに誤りがないか
通知を受け取る側のシステムが通知に応答しているか

通知の送信が繰り返し失敗する通知先は登録を削除する場合がありますので、通知が届かない状態が続いているときはお早めにご確認ください。

Q. テスト送信はできますか？

現在は対応しておりません。

Q. 通知の履歴は確認できますか？

現在、管理画面では確認できません。

Q. 受注の内容を取得するにはどうすればよいですか？

カラーミーショップのAPIを利用して取得します。APIの概要は「APIでできること」を、APIの仕様は「カラーミーショップ API ドキュメント」を、取得の手順は「【Webhook】通知を受け取るシステムを実装する」をご覧ください。

仕様