2021/11/11のUI刷新 第一弾リリースにてカラースキーム(配色設計)とタイポグラフィ(文字の書体、大きさ、配列のしかたなど)を変更しております。オンラインマニュアルに掲載している画面キャプチャと実際の管理画面の配色や文字の状態が異なる場合がございますがご了承いただけますと幸いでございます。
「SATORI」では、Web APIを提供しております。「SATORI」のWeb APIを使用することでカスタマー情報の登録・更新・削除やカスタマー情報の一括登録・一括更新、カスタマーアクションの追加が可能となります。
SATORI APIを利用した貴社システム側との連携方法や実装支援などはサポート範囲外とさせていただいており、
API連携に関してお伝えできる情報としましては、以下マニュアルに掲載されている情報のみとなります。
また、運用開始後にうまく連携されない場合のエラー解析やデバッグ対応についてもサポート範囲外となります。
技術的な知識を有している担当者様、もしくは連携先APIの仕様を理解されている担当者様に相談のうえ実装をご検討ください。
APIの種類について
「SATORI」の提供するAPIは、以下の3種類となります。
APIバージョン4
カスタマー情報を1件ずつ登録・更新・削除する際に使用します。
主に「SATORI」のフォーム機能以外で作成した独自フォームから「SATORI」へカスタマー情報を登録・更新するために使用します。
|
APIバージョン4 |
用途 |
| registration.json | カスタマー情報を新規登録する際に使用します |
| upsert.json | カスタマー情報を新規登録または更新する際に使用します |
| delete.json | カスタマー情報を削除する際に使用します |
カスタマーバルクAPI
一度に多くのカスタマー情報を登録・更新する際に使用します。
カスタマー情報の登録・更新はCSVファイルを用いて行います。
|
カスタマーバルクAPI |
用途 |
| registration.json | 一度に多くのカスタマー情報を新規登録する際に使用します |
| upsert.json | 一度に多くのカスタマー情報を新規登録または更新する際に使用します |
| status.json | 「registration.json」や「upsert.json」の処理状況を取得する際に使用します |
カスタマーアクション追加API
カスタマー詳細画面の最新アクション一覧に任意のアクションを追加する際に使用します。
|
カスタマーバルクAPI |
用途 |
| add_action.json | 最新アクション一覧に任意のアクションを追加する際に使用します |
API連携に必要なAPIキーについて
API連携には、管理画面から取得する以下4種類のAPIキーが必要です。
APIキーの取得方法などについては、こちらをご確認ください。
- user_key：ユーザーアクセスキー
- user_secret：ユーザーシークレットキー
- company_key：カンパニーアクセスキー
- company_secret：カンパニーシークレットキー