APIの操作方法をご紹介します。ホットプロファイルとAPI連携する際の参考としてご利用ください。
※API連携機能は「API連携」をお申し込みのお客様のみ無償で提供しております。
- API連携について
- API連携できるデータ
- ホットプロファイル側での設定（APIキー発行手順）
- （例）GoogleのARCを使ってAPI連携を行ってみる
- （例1）APIを使って名刺データを参照する方法
- （例2）APIを使って名刺データを登録する方法
- （例3）APIを使って名刺データを更新する方法
- 参考サイト
- 補足
API連携について
お客様システムよりホットプロファイルへREST APIを使用してリクエストを実行することで
JSON形式のレスポンスとしてホットプロファイルに登録のあるデータを取得することができます。
ＡＰＩの形式 ： REST
使用するプロトコル ： HTTPS
レスポンスのフォーマット ： JSON
文字コード ： UTF-8
アクセス制限 ： 5分あたり1000回
取得件数 ： 1アクセス1000件まで
API連携できるデータ
ホットプロファイルでAPI連携できるデータをご紹介します。
| 参照（抽出） | 登録 | 更新 | 削除 | |
| 名刺管理 | 〇 | 〇 | 〇 | 〇 |
| リード管理 | 〇 | 〇 | 〇 | 〇 |
| 会社管理 | 〇 | 〇 | 〇 | 〇 |
| 部署管理(各会社の部署) | 〇 | 〇 | 〇 | |
| ユーザー管理 | 〇 | 〇 | 〇 | 〇 |
| ユーザー部署管理 | 〇 | 〇 | 〇 | 〇 |
| 報告管理 | 〇 | 〇 | 〇 | 〇 |
| 商談管理 | 〇 | 〇 | 〇 | 〇 |
| タスク管理 | 〇 | 〇 | 〇 | 〇 |
| 商品マスター | 〇 | 〇 | 〇 | 〇 |
【関連記事】
・API仕様書
・API連携をする際の取得件数について
・API連携するための「商品種別」のIDは、どのように確認すれば良いですか？
ホットプロファイル側での設定（APIキー発行手順）
1. 「管理者」権限のアカウントでログインします。
2. [ 歯車マーク ] - [ ユーザー管理 ] - [ ユーザー管理 ] をクリックします。
3. [ ユーザー管理 ] 画面にて、APIキーを取得したいユーザーを検索します。
4. 該当ユーザーの [ 編集 ] から [ 外部サービス連携（API連携） ] を有効にします。
5.画面下部にある、[登録]ボタンをクリックします。
6.[ ユーザー管理 ] 詳細画面に戻りましたら [ 外部サービス連携（API連携） ] に
APIキーが記載されていますので、こちらのキーを取得します。
上記にて取得したAPIキーを任意の設定でご利用ください。
マイページからAPIキーを確認する
1. 右上のユーザー名をクリックし、[ マイページ ] を選択します。
2. 左側の [ 外部連携 ] をクリックし、APIキーを確認します。
（例）GoogleのARCを使ってAPI連携を行ってみる
API連携を行うための準備手順をご案内します。
※データ参照方法の一例となります。
※下記では、GoogleのARCを使っています。
お使いのソフトによって画面表示や操作方法が異なる場合があります。
1. ARCを立ち上げます。
2. 左ペインの [ HTTP Request ] をクリックします。
3. Request画面で、以下の設定をします。
・Method：「POST」を選択します。
・Request URL：ホットプロファイルのURL/エンドポイント.json
例）https://hammock.hotprofile.biz/rest_api/v1/business_cards/get_entry_list.json
※例は名刺管理の参照をするときのエンドポイントです。
名刺管理の更新や登録、また、名刺以外のデータを連携する場合などは上記と異なります。
※エンドポイントはAPI仕様書の [ エンドポイント ] を参照してください。
4. [ Headers ] タブを選択し、以下の設定をします。
・Header name：「Content-Type」を選択します。
・Hesder value：application/x-www-form-urlencoded
※API仕様書の [ HTTPヘッダー ] を参照してください。
5. [ Body ] タブを選択し、[ ADD FORM PARAMETER ] をクリックします。
6. 以下の設定を行います。
・Parameter name：api_key
・Parameter value：[ 外部サービス連携（API連携）] の [ APIキー ] を入力します。
▼APIキーの確認方法
（例1）APIを使って名刺データを参照する方法
名刺管理のデータを参照（抽出）する方法をご案内します。
※データ参照方法の一例となります。
※下記では、GoogleのARCを使っています。
お使いのソフトによって画面表示や操作方法が異なる場合があります。
【初期設定】
「（例）GoogleのARCを使ってAPI連携を行ってみる」の手順で、
「Request URL」のみ変更します。
Request URL：https://hammock.hotprofile.biz/rest_api/v1/business_cards/get_entry_list.json
※名刺データを登録をするときのエンドポイントです。
名刺の更新や削除、また、名刺以外のデータを連携する場合などは上記と異なります。
※エンドポイントはAPI仕様書の [ エンドポイント ] を参照してください。
【名刺データの参照方法】
① 名刺管理の1ページ目に表示される名刺データを抽出したい場合
1. [ ADD FORM PARAMETER ] をクリックし、以下の設定を行います。
・Parameter name：page[number]
・Parameter value：1 ※2ページ目が見たい場合は「2」と入れます。
2. [ SEND ] をクリックすると、下方に結果が表示されます。
② 会社名を指定して、アクティブ名刺のデータを抽出したい場合
1. [ ADD FORM PARAMETER ] をクリックし、以下の設定を行います。
1つ目
・Parameter name：search[client_name]
・Parameter value：検索したい会社名
2つ目
・Parameter name：search[status][]
・Parameter value：1 ※非アクティブ名刺を抽出したい場合は「2」と入れます。
2. [ SEND ] をクリックすると、下方に結果が表示されます。
（例2）APIを使って名刺データを登録する方法
名刺管理に名刺データを登録する方法をご案内します。
※データ参照方法の一例となります。
※下記では、GoogleのARCを使っています。
お使いのソフトによって画面表示や操作方法が異なる場合があります。
【初期設定】
「（例）GoogleのARCを使ってAPI連携を行ってみる」の手順で、
「Request URL」のみ変更します。
Request URL：https://hammock.hotprofile.biz/rest_api/v1/business_cards/create.json
※名刺データを登録をするときのエンドポイントです。
名刺の更新や削除、また、名刺以外のデータを連携する場合などは上記と異なります。
※エンドポイントはAPI仕様書の [ エンドポイント ] を参照してください。
【名刺データの登録方法】
※名刺の登録は、「会社ID」「姓」「ステータス」「公開ステータス」が必須項目です。
※本手順では、1件ずつの登録方法となります。
1. [ ADD FORM PARAMETER ] をクリックし、必須項目と登録したい項目に値を入れます。
(画像では、必須項目以外に「名」「メールアドレス」「電話番号」を追加しています。)
2. [ SEND ] をクリックすると、下方に結果が表示されます。
エラーになっている場合は、入れている値を再度確認してください。
（例3）APIを使って名刺データを更新する方法
名刺管理に名刺データを登録する方法をご案内します。
※データ参照方法の一例となります。
※下記では、GoogleのARCを使っています。
お使いのソフトによって画面表示や操作方法が異なる場合があります。
【初期設定】
「（例）GoogleのARCを使ってAPI連携を行ってみる」の手順で、
「Request URL」のみ変更します。
Request URL：https://hammock.hotprofile.biz/rest_api/v1/business_cards/update.json
※名刺データを登録をするときのエンドポイントです。
名刺の登録や削除、また、名刺以外のデータを連携する場合などは上記と異なります。
※エンドポイントはAPI仕様書の [ エンドポイント ] を参照してください。
【名刺データの更新方法】
※名刺の更新は、「名刺ID」「会社ID」が必須項目です。
※本手順では、1件ずつの更新方法となります。
1. [ ADD FORM PARAMETER ] をクリックし、必須項目と更新したい項目に値を入れます。
(画像では、必須項目以外に「タグ」「住所」を追加しています。)
※タグも上書き更新となります。すでに付与しているタグと追加したいタグの両方を設定します。
2. [ SEND ] をクリックすると、下方に結果が表示されます。
エラーになっている場合は、入れている値を再度確認してください。
参考サイト
APIについて書かれている一般サイトです。
API設定時の参考にしてください。
・APIの仕組みが分かる・使いこなせる人材になれる記事
・簡単な処理を行うAPIの作り方
・APIの設計手順
・WebAPIについての説明
補足
APIの設定方法などの詳細については、サポート範囲外となります。
貴社のAPIに詳しい方などにご確認ください。
ご理解ご了承の程、何卒よろしくお願いいたします。