メインコンテンツへスキップ

​
はじめに

POST /v1/enrich を使うと、外部Web情報から収集した構造化データで会社レコードを更新できます。 このエンドポイントは v1では company のみ対応 しており、標準項目と明示的にマッピングしたカスタム項目へ書き込みます。

​
使う場面

次のような場面で利用します。
  • 会社プロフィールの不足項目を補完したいとき
  • 古くなった会社情報をWeb上の情報で更新したいとき
  • CRMレコードを更新する前に、項目ごとの根拠を確認したいとき
必須のリクエスト項目:
  • object_type: company を指定します
  • record_id: 会社レコードのUUIDです

​
リクエストを送る

curl -X POST "https://api.sanka.com/v1/enrich" \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "object_type": "company",
    "record_id": "11111111-2222-3333-4444-555555555555",
    "custom_field_map": {
      "industry": "cf_12345",
      "employee_count": "cf_67890"
    }
  }'
同じリクエストは APIリファレンス → データエンリッチメント のPlaygroundからも試せます。

​
レスポンスを確認する

レスポンスには次の情報が含まれます。
  • updated_builtin_fields: 実行中に更新された標準項目
  • updated_custom_fields: 更新されたマッピング済みカスタム項目
  • proposed_fields: パイプラインが候補として見つけた値
  • field_evidence: 採用された値ごとの根拠情報
  • skipped_fields: 信頼度や上書き条件を満たさず反映されなかった項目
  • provider_meta: エンリッチメント提供元に関するメタ情報
トップレベルのレスポンス形式は他のAPIと共通です。
{
  "data": {
    "company_id": "<company_uuid>",
    "run_id": "<run_uuid>",
    "pipeline_version": "v1",
    "updated_builtin_fields": {},
    "updated_custom_fields": {},
    "proposed_fields": {},
    "field_evidence": {},
    "skipped_fields": {},
    "provider_meta": {}
  },
  "message": "ok",
  "ctx_id": "<ctx_id>"
}

​
dry_runとforce_refresh

dry_run を使うと、実際には書き込まずに候補値と根拠だけを確認できます。
{
  "object_type": "company",
  "record_id": "11111111-2222-3333-4444-555555555555",
  "dry_run": true
}
force_refresh を使うと、書き込みルールが許可する範囲で既存値の上書きを評価できます。
{
  "object_type": "company",
  "record_id": "11111111-2222-3333-4444-555555555555",
  "force_refresh": true
}