API リファレンス
SDK のアクティベーション、ディアクティベーション、設定、担当者
エンドポイント POST /api/v1/sdk/activate, POST /api/v1/sdk/deactivate, GET /api/v1/sdk/config, PUT /api/v1/sdk/contacts
Odoo モジュールはこの4つの呼び出しを使います。インストールごとに1キーの紐付け、公開キー、プランの機能を必要とするサーバー側の連携なら、同じように使えます。
1アクティベート
シークレットキーで POST /api/v1/sdk/activate。ボディ:instance_id(必須、8〜128文字。インストールの安定したフィンガープリント)、base_url、platform、platform_version、terms_version、accepted_by(利用規約に同意した人)。レスポンスは 200 {project, org, enabled, public_key, features: {security_monitoring, plan, seats}}。seats は無制限の場合 null。409 {reason: 'instance_bound_elsewhere'} はこのインストールが既に別のプロジェクトに報告している場合。409 {reason: 'project_has_instance'} はこのキーが既に別のインストールに属している場合。
curl https://in.blipit.io/api/v1/sdk/activate \
-H "Content-Type: application/json" -H "X-Blipit-Key: <secret key>" \
-d '{"instance_id":"7c1e0f9a2b3d4e5f6a7b8c9d0e1f2a3b","platform":"odoo","platform_version":"19.0","terms_version":"2026-09-28","accepted_by":"admin@example.com"}'2ディアクティベート
シークレットキーと X-Blipit-Instance で POST /api/v1/sdk/deactivate。ボディ(任意):released_by(接続を解除した人。例:メールアドレス)。このインストールとプロジェクトの紐付けを削除し、別のデータベースがキーを接続できるようにします。監査ログには key.instance_released が記録されます。レスポンスは 200 {released: true}、このインストールが紐付けられていなかった場合は 200 {released: false} なので、繰り返し呼んでも安全です。X-Blipit-Instance がない場合は 400、不明なキーは 401、公開キーまたは別のプロジェクトに紐付けられたインストールは 403。その後、そのインスタンスを含むリクエストは再びアクティベートされるまで 403 になります。
curl https://in.blipit.io/api/v1/sdk/deactivate \
-H "Content-Type: application/json" -H "X-Blipit-Key: <secret key>" -H "X-Blipit-Instance: 7c1e0f9a2b3d4e5f6a7b8c9d0e1f2a3b" \
-d '{"released_by":"admin@example.com"}'3設定
シークレットキーと X-Blipit-Instance で GET /api/v1/sdk/config。レスポンスは {public_key, features, sdk, odoo}。プランの変更や新しい公開キーに気づけるよう、時々ポーリングしてください(Odoo は10分ごとに行います)。
4担当者
シークレットキーと X-Blipit-Instance で PUT /api/v1/sdk/contacts。ボディ {companies: [{id, name, people: [{id, name, email}]}]}。異なる担当者は、メンバー、招待、メールルールとともにプランのシートに対して数えられます。レスポンスは 200 {used, seats, plan}、またはリストがシートを超えて人を追加する場合は 409 {reason: 'seats_exceeded', seats, used, plan}。減るだけのリストは常に受け付けられます。
{
"companies": [
{ "id": "1", "name": "Acme SG", "people": [{ "id": "2", "name": "Ana Lim", "email": "ana@example.com" }] },
{ "id": "2", "name": "Acme PH", "people": [{ "id": "7", "name": "Ben Cruz", "email": "ben@example.com" }] }
]
}知っておくと便利
- アクティベーション後、そのインストールからのすべてのリクエストには X-Blipit-Instance が必要です。不一致の場合は 403「このキーは別のインスタンスに紐付けられています」を受け取ります。
- 一度紐付けられると、紐付けはディアクティベート(インストール自身から)または Blipit ダッシュボードからのみ変更できます。
お困りですか?support@blipit.io までメールしてください。各プロジェクトのキーとプロジェクト ID は app.blipit.io の「APIキー」にあります。