「HOTLEAD公開API」を利用することで、HOTLEADにAPI経由で反響の作成と追客情報の取得をすることができます
メール等を介さずに自社システムから連携などにご活用ください
はじめに、APIを利用するアプリケーションを作成します
右上の窓口の絞り込みより反響登録を行う窓口を1つ指定します
API連携(開発者向け)画面へアクセスします
API連携(開発者向け)(https://client.hotlead.jp/settings/accesskey)
「反響登録OAuthアプリケーション」画面で「新規作成」をクリックします
アプリケーションを作成されると「OAuthクライアントID」と「OAuthクライアントシークレット」が発行されます(権限が管理者&編集者のみ)
※「OAuthクライアントシークレット」は新規作成時にしか確認できないので、ご注意ください
発行された「OAuthクライアントID」と「OAuthクライアントシークレット」をもとにアクセストークンを発行します
# 変数の設定
CLIENT_ID='[OAuthクライアントID]'
CLIENT_SECRET='[OAuthクライアントシークレット]'
CODE=`echo -n ${CLIENT_ID}:${CLIENT_SECRET} | base64`
# アクセストークンの発行
curl -X POST <https://prd-hotlead.auth.ap-northeast-1.amazoncognito.com/oauth2/token> \\
-H "Authorization: Basic $CODE" \\
-H "Content-Type: application/x-www-form-urlencoded" \\
-d "grant_type=client_credentials" \\
-d "client_id=${CLIENT_ID}"
これにより、jsonデータのアクセストークンが発行されます
{
"access_token": [アクセストークン],
"expires_in": 3600,
"token_type": "Bearer"
}
アクセストークンの有効期限は1時間です
アクセストークンの有効期限が切れた場合はアクセストークンを再発行してください
発行されたアクセストークンをもとに反響を登録します
下記の例は会員登録など物件反響が存在しない反響の登録例です
curl -i -X POST \\
-H "authorization: Bearer [アクセストークン]" \\
-H 'Content-Type: application/json' \\
-d '{
"created_at": "2024-04-22T10:00:01+09:00",
"media_domain": "[反響が発生したメディアのドメイン]",
"unit_id": [反響登録をする窓口ID],
"profile": {
"name": "[お客様名]",
"email": "[お客様のメールアドレス]",
"phone": "[お客様の電話番号]",
"address": "[お客様の住所]"
}
}' <https://public-api.hotlead.jp/public/api/leads>
以下のようなレスポンスが返ってくれば反響登録の成功です
HTTP/2 204
date: Wed, 22 Feb 2023 07:05:54 GMT
cache-control: no-store
pragma: no-cache
strict-transport-security: max-age=10886400; includeSubdomains
vary: Origin
x-content-type-options: nosniff
x-frame-options: SAMEORIGIN
x-xss-protection: 1; mode=block
HOTLEAD反響登録APIの詳細については、HOTLEAD反響登録APIドキュメントをご確認ください
お客様の詳細な情報や問い合わせ頂いた反響に関する情報も合わせて登録していただけると、より詳細なヒアリングや質の高い追客が可能となるので、可能な限りパラメータを埋めた状態で反響登録頂ければ幸いです