REST APIとWebhook

複数のAPIキーと署名付きWebhookを備えた、公開REST API

Webサイト、フォーム、バックエンドから、HTTP呼び出し1回で顧客を登録し、すべての変更をHMAC-SHA256で署名されたかたちで自分のサーバーに受け取れます。

CRMは、わざわざ開いて入力する場所ではなくなり、あなたのシステムが呼び出すエンドポイントになります。

AIsToHire のCRMアプリ AiCrm は、自分の連絡先に対する公開REST APIを提供します。`X-Api-Key` ヘッダーにキーを指定すれば、Webサイトのフォーム、チャットボット、Zap、Pythonスクリプト、自社のバックエンドから、連絡先の作成、一覧取得、参照、更新、削除ができ、どの連絡先にもアクティビティを追加できます。レスポンスは `{ success, data }` の形式のJSONで、上限はキーごとに1分あたり100リクエストです。

APIからの登録は重複しません。送信したメールがすでにデータベースにある場合、AiCrm はすでにあるカードを更新し(足りない電話番号、名前、会社を補い、タグを結合)、新しい送信をタイムラインに記録して、HTTP 200を返します。新規の場合は作成して201を返します。APIで入ってきた連絡先には、自動的に `api-lead` のタグが付き、送信したタグはそのまま保持され、流入元の `subId` と、アクセス元の国、IP、ブラウザが保存されます。

名前付きのAPIキーは、アプリ内部のキーに加えて、最大20個まで作成できます。連携ごと(Webサイト、5月のキャンペーンのフォーム、インターン、取引先)に別のキーを渡し、その連携が終わったら、他に触れずにそのキーだけを無効化できます。キーの完全な値は、作成時に一度だけ表示され、その後は一覧でマスクされた状態でしか見られません。

逆方向では、Webhookがシステムに通知します。最大10の宛先を設定し、それぞれが購読するイベント(`customer.created`、`customer.updated`、`customer.deleted`、`activity.created`)を選ぶと、AiCrm が `X-AiCrm-Event` と `X-AiCrm-Signature: sha256=…` のヘッダーを付けて、あなたのURLにPOSTします。後者は、そのWebhookのシークレットで計算した本文のHMAC-SHA256署名で、配信が正当なものかを検証できます。URLの保存時には、SSRF対策により、localhost、127.0.0.0/8、10.x、192.168.x、172.16-31.x、::1、0.0.0.0、そして `.local` と `.internal` のドメインが拒否されます。

REST APIとWebhookのメリット

Ventaja 1

1回の呼び出しで連絡先を登録できます。メールと好きなタグを付けて `/api/apps/public/crm/customers` にPOSTすると、リードはすぐにCRMに分類されて入ります。

Ventaja 2

設計上、重複しません。メールがすでに存在する場合は、2枚目のカードを作る代わりに、カードを更新し、新しい送信をタイムラインに記録します。

Ventaja 3

名前付きのキーを最大20個。連携ごとに1つで、個別に無効化できます。キーが漏れた場合は、そのキーだけを削除すれば、他は何も止まりません。

Ventaja 4

HMAC-SHA256で署名されたWebhook。自分のシークレットで `X-AiCrm-Signature` ヘッダーを検証すれば、通知が第三者ではなく自分のCRMから来たと分かります。

Ventaja 5

SSRF対策が最初から入っています。アプリは、localhostやプライベートネットワークの範囲へのWebhook配信を拒否するので、CRMを内部ネットワークの探索に使われることはありません。

Ventaja 6

登録だけでなく、CRUDを完全にサポート。ページネーションとフィルター(検索、ステータス、タグ、国)つきの一覧、アクティビティを含む連絡先の取得、更新、削除、アクティビティの記録ができます。

Ventaja 7

流入元を自動で追跡します。API経由の登録ごとに、送信した `subId` に加えて、国、IP、ブラウザが保存され、`api-lead` のタグが付くので、あとでアプリ内で絞り込めます。

Ventaja 8

当て推量なしでテストできます。アプリには、コピーできる `curl` の例つきのエンドポイントのドキュメントがあり、各Webhookにテスト配信を送るボタンと、最後の試行のステータスと時刻も表示されます。

Claire Donovan

今日の午後のうちに、WebサイトとCRMをつなごう

AiCrm は、AIsToHire のCRMツールで、REST API経由で連絡先を受け取り、署名付きWebhookでシステムに通知します。アカウントを作成し、キーを生成して、最初の呼び出しを行いましょう。

署名付きWebhookを備えたCRM向けREST API | AiCrm