対応一覧

現在のデータ管理APIで利用できる操作を確認できます。

概要

データ管理 APIでは、主要なCRM・ERPレコードに対するCRUDに加え、対応している範囲でワークフロー、レポート、プロパティ管理のエンドポイントも利用できます。Dealオブジェクトは、データ管理APIでは /v1/public/deals として公開されています。 Expenseオブジェクトは、データ管理APIでは /v1/public/expenses として公開されています。

対応状況

オブジェクト	一覧	取得	作成	更新	削除	補足
Deals (`/v1/public/deals`)	✅	✅	✅	✅	✅	旧 `/v1/public/cases` エイリアスが残っている場合がありますが、公開ドキュメントでは `/deals` を使用します
Companies	✅	✅	✅	✅	✅	`external_id` によるUpsert対応。削除はアーカイブです
Contacts	✅	✅	✅	✅	✅	`external_id` によるUpsert対応。削除はアーカイブです
Orders	✅	✅	✅	✅	✅	単件・一括作成に対応。削除はアーカイブです
Items	✅	✅	✅	✅	✅	`external_id` によるUpsert対応。削除はアーカイブです
Inventories	✅	✅	✅	✅	✅	`external_id` によるUpsert対応。削除はアーカイブです
Inventory Transactions	✅	✅	✅	✅	✅	削除はアーカイブです
Subscriptions	✅	✅	✅	✅	✅	削除はアーカイブです
Estimates	✅	✅	✅	✅	✅	削除はアーカイブです
Invoices	✅	✅	✅	✅	✅	削除はアーカイブです
Purchase Orders	✅	✅	✅	✅	✅	`external_id` によるUpsert対応。削除はアーカイブです
Expenses (`/v1/public/expenses`)	✅	✅	✅	✅	✅	`external_id` によるUpsert対応。削除はアーカイブです
Bills	✅	✅	✅	✅	✅	`external_id` によるUpsert対応。削除はアーカイブです
Disbursements	✅	✅	✅	✅	✅	`external_id` によるUpsert対応。削除はアーカイブです
Slips	✅	✅	✅	✅	✅	`external_id` によるUpsert対応。削除はアーカイブです
Payments	✅	✅	✅	✅	✅	`external_id` によるUpsert対応。削除はアーカイブです
Locations	✅	✅	✅	✅	✅	`external_id` によるUpsert対応。削除はアーカイブです
Meters	✅	✅	✅	✅	✅	`external_id` によるUpsert対応。削除はアーカイブです
Workflows	✅	✅	✅	❌	❌	`POST /v1/public/workflows` で `external_id` によるUpsertに対応します
Reports	✅	✅	✅	✅	✅	Salesforce形式の `reportMetadata` を利用。削除はアーカイブです
Properties (Schema)	✅	✅	✅	✅	✅	Cases、Locations、Meters はプロパティ書き込みが読み取り専用です

例: Dealの操作

公開の Deals API を使って、Dealレコードの作成、更新、確認、削除を行います。

準備するデータ

主に使う項目:

Dealの外部ID（例: DEAL-2026-0001）
Deal名（例: Enterprise expansion）
会社または連絡先の参照（任意、companyExternalId, contactExternalId）
ステータス関連の項目（任意、status, caseStatus）

Dealを作成する

curl -X POST "https://api.sanka.com/v1/public/deals" \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "externalId": "DEAL-2026-0001",
    "name": "Enterprise expansion",
    "status": "open",
    "caseStatus": "Qualified",
    "currency": "USD",
    "companyExternalId": "ACME-001",
    "contactExternalId": "CONTACT-100"
  }'

成功すると、レスポンスには case_id、external_id、status、ctx_id が含まれます。

Dealを更新する

返ってきた case_id を使って対象レコードを更新します。

curl -X PUT "https://api.sanka.com/v1/public/deals/<case_id>" \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Enterprise expansion - renewal",
    "caseStatus": "Proposal",
    "companyExternalId": "ACME-001"
  }'

更新後は次のリクエストで結果を確認できます。

curl -X GET "https://api.sanka.com/v1/public/deals/<case_id>" \
  -H "Authorization: Bearer <access_token>"

Dealを削除する

不要になったレコードは削除できます。

curl -X DELETE "https://api.sanka.com/v1/public/deals/<case_id>" \
  -H "Authorization: Bearer <access_token>"

関連してよく使うエンドポイント:

Deal一覧: GET /v1/public/deals
Deal詳細: GET /v1/public/deals/{case_id}
Dealパイプライン一覧: GET /v1/public/deals/pipelines

AIエンドポイント

AIエンドポイントは /v1/public/... ではなく v1 直下の名前空間を使うため、APIリファレンス上でも別グループとして分かれています。

データエンリッチメントでは会社データ向けの POST /v1/enrich、リクエスト例、dry_run、force_refresh を説明しています
データスコアリングでは企業と取引レコード向けの POST /v1/score、レスポンス項目、curl例、決定的なスコア結果の構造を説明しています

補足

データ管理APIは /v1/public/... 名前空間を使います。
AIエンドポイントは /v1 直下の名前空間を使います。
トークン権限は Regular（読み取りのみ） または Full Access（読み取り・書き込み） を使い、AIエンドポイントでは追加でOAuth権限も必要です。

PreviousNode / Python SDK Nextデータエンリッチメント