データAPI
企業と取引のエンリッチメント・営業リスト・スコアリングを担うAI系エンドポイントです。
概要
データAPI は、オブジェクトAPIのCRUDとは別に用意されているAI系エンドポイント群です。担当する役割は大きく3つに分かれます。会社データの不足を埋める エンリッチメント、新しいターゲット企業を見つける 営業リスト、そして企業や取引をスコアリングする スコアリング です。いずれも単一のPOSTエンドポイントで、/v1/public/... ではなく /v1 直下の名前空間を利用します。レスポンスは決定的で構造化されているため、Sankaレコードにそのまま保存したり、HubSpot・Salesforceへ書き戻したりできます。エンドポイント
| API | エンドポイント | 入力 | 出力 |
|---|---|---|---|
| エンリッチメント | POST /v1/enrich | 既存の会社の record_id、または一時的な seed オブジェクト | Webエビデンスから更新した会社項目 |
| 営業リスト | POST /v1/prospect/companies | 自然文の query、または業種・地域・従業員数などの構造化フィルタ | 条件に合う会社候補のランキング |
| スコアリング | POST /v1/score | 会社の record_id、または取引の record_id | 次元と理由付きの決定的スコア |
使い分け
- エンリッチメント — レコードはすでにあり、業種・規模・Webサイト・概要などの不足項目を埋めたい、または最新のWebエビデンスで更新したいときに使います。
dry_run: trueを付けると、書き込まずに更新案だけを確認できます。 - 営業リスト — まだレコードが無い段階で使います。「東京の従業員200名以上の製造業」のように条件を指定すると、会社候補のランキングが返ります。そのままSanka上で会社を作成したり、HubSpot・Salesforceに送ったりできます。
- スコアリング — 会社や取引に対して、決定的なフィットスコア・ヘルススコアを付けたいときに使います。リードの優先度付け、取引レビュー、更新リスクの早期検知などに活用できます。レスポンスには理由が構造化されて含まれるため、スコアの「根拠」を営業担当と共有できます。
認証
データAPIはいずれも Full Access スコープのBearerトークンで呼び出します。Regular（読み取りのみ）のトークンは、レコードの作成・更新やAIクレジットの消費を伴うため拒否されます。Bash
Authorization: Bearer <access_token>
Content-Type: application/json
402 Payment Required とコードが返るので、管理者に通知する仕組みを用意しておくと安心です。例: 会社をエンリッチする
データAPIをはやく試すなら、既存のSanka会社をエンリッチする方法がおすすめです。<record_id> は自分が所有する会社に置き換えてください。cURL
curl -X POST "https://api.sanka.com/v1/enrich" \
-H "Authorization: Bearer <access_token>" \
-H "Content-Type: application/json" \
-d '{
"record_id": "<company_record_id>",
"dry_run": true
}'
dry_run: true を付けたリクエストでは、提案された更新内容がレスポンスに入り、レコードは書き換わりません。実際に適用する準備ができたらフラグを外して呼び出します。リクエストパターンやレスポンス項目、インタラクティブなプレイグラウンドは エンリッチメント / 営業リスト / スコアリング の各ページを参照してください。補足
- データAPIは
/v1直下の名前空間を使います。オブジェクト（データ管理）APIは/v1/public/...名前空間です。 - 同じ入力とアルゴリズムバージョンならレスポンスは決定的なので、
(record_id, algorithm_version)でキャッシュしても問題ありません。 - 各エンドポイントにはAPIリファレンス内にプレイグラウンドがあります。コードを書く前に、リクエストの形を手早く確認できます。
- v1ではバッチ版のエンドポイントは提供していません。大量処理を行う場合は、レート制限を守りつつレコードごとに呼び出してください。
