REST APIとAPIキー(インテグレーション)
APIキーによる認証を用いて、REST API経由でCRMを他システムと連携します。
Sellioは、Zapier、Make、独自のスクリプトなど、他システムからレコードを読み書きするためのREST APIを提供しています。アクセスは、設定→APIとキーで発行するAPIキーによって認証されます。
キーを発行する
- 設定→APIとキーに移動します。
- 名前を付け(例:「Zapier連携」)、「キーを発行」をクリックします。
- キーはその場ですぐにコピーしてください。表示されるのは一度きりで、後から取得することはできません。
- 連携を無効にするには「失効」を使用してください。キーは即座に使用できなくなります。
💡 このキーは組織のデータへの完全なアクセス権を持ちます。パスワードと同様に扱い、公開コードやブラウザ上に決して露出させないでください。
エンドポイント
- GET /api/v1/{object}:レコードの一覧を取得します(パラメータ:limit、offset、search)。
- GET /api/v1/{object}/{id}:単一のレコードを取得します。
- POST /api/v1/{object}:レコードを作成します(項目を含むJSONボディ)。
- PATCH /api/v1/{object}/{id}:レコードの項目を更新します。
キーはヘッダー Authorization: Bearer sk_live_… で送信してください。{object}にはオブジェクトのAPI名(contact、company、lead、opportunity、または独自オブジェクトの名前)を指定します。
Example: curl -H "Authorization: Bearer sk_live_..." https://www.selliocrm.com/api/v1/opportunity
💡 このAPIは、画面から操作した場合と全く同じように、CRMのバリデーションとビジネスルール(必須項目、バリデーションルールなど)を尊重します。
レート制限と使用量(SLA)
各キーには1分あたりのリクエスト数の上限があり(デフォルト120)、キー一覧の画面から調整できます。すべてのレスポンスには、X-RateLimit-Limit(上限値)、X-RateLimit-Remaining(現在のウィンドウであと何回リクエストできるか)、X-RateLimit-Reset(ウィンドウがリセットされる時刻、エポック秒)のヘッダーが含まれます。
上限を超えると、APIは429(Too Many Requests)を返し、Retry-Afterヘッダーで再試行までの待機秒数を示します。キー画面には、各キーによるこれまでの総リクエスト数(使用量の指標)も表示されます。
💡 ご自身の使用量に応じて上限を設定してください。0にするとそのキーの制限は無効になります。サードパーティ連携には小さめの上限を、信頼できる社内処理には大きめの上限を使用してください。