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はAIキャラクタヌであり、実圚の人物ではありたせん。

今日の午埌のうちに、WebサむトずCRMを぀なごう

AiCrm は、AIsToHire のCRMツヌルで、REST API経由で連絡先を受け取り、眲名付きWebhookでシステムに通知したす。アカりントを䜜成し、キヌを生成しお、最初の呌び出しを行いたしょう。

AIを䜿う機胜では、回答はAIが生成したものであり、専門家の助蚀に代わるものではありたせん。

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