SDK 激活、停用、配置与联系人

Endpoint POST /api/v1/sdk/activate, POST /api/v1/sdk/deactivate, GET /api/v1/sdk/config, PUT /api/v1/sdk/contacts

Odoo 模块使用这四个调用。任何需要“每次安装一个密钥”绑定、公钥和套餐功能的服务端集成都可以以相同方式使用它们。

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'} 表示此密钥已属于另一个安装。

sh
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,直到它再次激活。

sh
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 每十分钟一次)以察觉套餐变更或新的公钥。

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};只减少的列表始终会被接受。

json
{
  "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“this key is bound to a different instance”。
  • 绑定后,只能通过停用(从安装本身发起)或 Blipit 控制台更改绑定。

遇到问题?发邮件至 support@blipit.io。每个项目的密钥和项目 id 在 app.blipit.io 的“API 密钥”下。