APIとWebhook · Enterprise
見積をほかの業務システムとつなぐ
QuotWayのREST APIを使えば、ERP、CRM、独自のストアフロントから見積を読み取り、新しい見積依頼を送れます。署名付きのWebhookは、バイヤーが承認した、再見積を返した、見積が変換されたといった出来事を、その瞬間にお使いのシステムへ知らせます。スコープ付きキー、個人情報を含まないペイロード、公開された制限値。Enterpriseプランで利用できます（14日間の無料トライアル中も利用可能）。
Enterprise · 14日間のトライアルでもAPIを利用可能 · OpenAPI 3.1仕様
二つの入り口
QuotWayはほかのシステムと二つの方法でつながります。お使いのシステムが呼び出して見積を読み取り・作成するREST APIと、見積が変わるたびにQuotWayがお使いのシステムへ送るWebhookです。多くの連携では両方を使います。Webhookが「何かが起きた」と伝え、APIが「その詳細」を返します。
- REST API - https://api.quotway.com/v1：見積の一覧と取得、見積依頼の作成、メッセージの投稿、チームが価格を付けた提案の送付、PDFのダウンロード、分析データの取得
- Webhook - 25種類の見積イベントについて署名付きのHTTPSリクエストを送信。新しい依頼から、承認・変換・支払い済みの注文まで
つくれるもの
APIとWebhookを組み合わせて連携できるものの例です。
ERP連携と注文の同期
下書き注文が作成された瞬間にquote.convertedを、支払いが済んだときにquote.order_completedを受け取り、見積の明細と合計をERPに取り込めます。
CRMのパイプライン
すべての見積を商談として反映できます。Webhookでステージを進め、APIで金額を埋めます。金額には見積のheadlineの数値を使うため、一部だけ承認された見積でも、当初の提示額ではなく実際に合意した内容が表示されます。
ヘッドレスと独自のストアフロント
POST /v1/quotesで、どのフロントエンドからでも見積依頼を送れます。依頼はオンラインストアと同じターゲティングルール、フォームの検証、自動化を通ります。
経理とレポーティング
見積をデータウェアハウスへ差分で同期したり、パイプライン、成約率、応答時間の集計済み指標を日・週・月単位で取得したりできます。
チームへの通知
quote.merchant_approval.requestedや高額のquote.createdを、チームがふだん見ているツールに流せます。
Enterprise
本番運用のための設計
APIは、BtoBの事業者が実際に動かしているシステムのために作られています。挙動が予測でき、ドキュメントがあり、安全に再試行できます。
スコープ付きキー
五つのスコープ（見積の読み取り、バイヤーの個人データの読み取り、分析の読み取り、見積の書き込み、Webhookの管理）。有効期限とIP許可リストは任意で設定できます。24時間の重複期間を設けてキーをロールでき、即座に失効させることもできます。管理者のみが操作できます。
バイヤーのデータは明示的に許可した場合のみ
見積にバイヤーの氏名、メールアドレス、電話番号、住所が含まれるのは、バイヤーデータのスコープを付与したキーの場合だけです。Webhookのペイロードにバイヤーの個人データが含まれることはありません。見積を特定し、そこへのリンクを示すだけです。
Standard Webhooksの署名
Node、Pythonなどに対応した公式のオープンソースライブラリで配信を検証できます。シークレットは24時間の重複期間を設けてローテーションできます。
意識しなくてよい再試行
失敗した配信は、間隔を空けながら約3.7日間再試行されます。配信ログですべての試行を確認でき、どの配信も再送できます。
取りこぼしがない
すべてのイベントは、Webhookと同じIDでイベントフィードからも30日間取得できます。停止していた受信側も後から追いつけます。
安全な再試行
すべての書き込みにIdempotency-Keyを付けられるため、ネットワークのタイムアウトで見積やメッセージが重複して作成されることはありません。
明確な仕様
OpenAPI 3.1仕様、失敗ごとに安定したコードを持つRFC 9457形式のエラー、カーソル方式のページネーション、公開されたレート制限（キーごとに毎分120リクエスト、ストアごとに300）。
価格を決めるのは、これまでどおりチームです
QuotWayのAPIが価格を設定することはありません。APIにできるのは、バイヤーの依頼を記録することと、チームがすでに価格を付けて保存した提案を送ることです。その場合でも、下限価格と承認ポリシーは管理画面とまったく同じように適用されます。
- APIからの見積依頼にはShopifyのカタログ価格が使われ、提案の価格はいつもどおりチームが付けます
- 下限価格を下回る準備済みの提案を送るには、管理画面と同じ明示的な確認が必要です。下限には、管理画面と同じく見積全体の値引きも含まれます
- 見積全体に対する金額指定の値引きが提案の小計を超える場合、送信は拒否されます（422 invalid_proposal）
- 承認ポリシーが適用される場合、提案はバイヤーに送られず、承認者の判断を待ちます
4ステップで接続
- 1
キーを作成する
QuotWayで「設定 → 連携 → APIキー」を開き、スコープを選んでキーをコピーします。
- 2
最初の呼び出しを行う
キーを付けてhttps://api.quotway.com/v1/pingにcurlでリクエストすると、ストアとスコープを確認できます。
- 3
Webhookのエンドポイントを追加する
「設定 → 連携 → Webhook」でHTTPSのURLを追加し、イベントを選んで署名シークレットをコピーします。
- 4
検証して処理する
各配信の署名を検証して200を返し、詳細が必要なときに見積を取得します。
関連情報
疑問にお答えします
QuotWayにAPIはありますか？
はい。QuotWayにはhttps://api.quotway.com/v1にREST APIがあり、見積の読み取り、見積依頼の作成、メッセージの投稿、準備済みの提案の送付、見積PDFのダウンロード、分析データの読み取りができます。OpenAPI 3.1仕様で文書化されており、Enterpriseプランで利用できます。
QuotWayはWebhookに対応していますか？
はい。QuotWayは25種類の見積イベントについて、署名付きのHTTPS Webhookを送信します。見積の作成、提案の送付、再見積、承認、一部承認、辞退、下書き注文への変換、注文の支払い、承認の依頼と判断などが含まれます。WebhookはStandard Webhooksの仕様に準拠し、Enterpriseプランで利用できます。
APIとWebhookはどのプランに含まれますか？
Enterpriseプラン（$199/月）です。14日間の無料トライアル中のストアでも両方を使えるため、契約前に構築とテストができます。ストアが下位のプランに移った場合、キーとエンドポイントは残りますが、一時停止されます。
ヘッドレスのストアフロントから見積を作成できますか？
はい。POST /v1/quotesで、どのフロントエンドからでもバイヤーの見積依頼を記録できます。明細はShopifyの商品バリエーションを参照するか、カスタム明細として作成でき、依頼はストアのターゲティングルール、見積フォームの検証、自動化ルールを、オンラインストアからの依頼とまったく同じように通ります。
APIで価格を変更したり、見積を承認したりできますか？
いいえ。APIが価格を設定・編集することはなく、誰かに代わって見積を承認・辞退・変換することもできません。できるのは、チームがすでにQuotWayで価格を付けて保存した提案を送ることで、その場合も下限価格と承認ポリシーが適用されます。
Webhookに顧客データは含まれますか？
いいえ。Webhookのペイロードは見積を特定し、状況、通貨、合計といった短い要約を含みますが、バイヤーの氏名、メールアドレス、電話番号、住所は含みません。これらが必要な場合は、バイヤーデータのスコープを持つキーでAPIから見積を取得してください。
エンドポイントが停止していたらどうなりますか？
QuotWayは失敗した配信を約3.7日間で7回再試行し、すべてのイベントはイベントフィードから30日間取得できるため、後から追いつけます。5日間連続で失敗し続けたエンドポイントは無効化され、ストアにメールで通知されます。
ZapierのアプリやHubSpotとの連携はありますか？
現時点ではありません。REST APIとWebhookでほかのツールと、またShopify Flow連携でShopify自身の自動化とQuotWayをつなげられます。
見積を、事業が動いている場所へ
QuotWayを無料で追加し、Enterpriseの14日間のトライアルを始めて、最初のシステムをAPIとWebhookでつなぎましょう。ドキュメントがあり、スコープで制御でき、署名付きです。
Liteプランは無料 · 有料プランは14日間の無料トライアル · Shopify Plusに対応