Activación, desactivación, configuración y contactos del SDK

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

El módulo de Odoo usa estas cuatro llamadas. Cualquier integración en el servidor que quiera vinculación de una clave por instalación, la clave pública y las funciones del plan puede usarlas de la misma forma.

1Activar

POST /api/v1/sdk/activate con la clave secreta. Cuerpo: instance_id (obligatorio, de 8 a 128 caracteres; una huella estable de la instalación), base_url, platform, platform_version, terms_version, accepted_by (quién aceptó los Términos). Responde 200 {project, org, enabled, public_key, features: {security_monitoring, plan, seats}}; seats es null si es ilimitado. 409 {reason: 'instance_bound_elsewhere'} cuando esta instalación ya reporta a otro proyecto; 409 {reason: 'project_has_instance'} cuando esta clave ya pertenece a otra instalación.

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"}'

2Desactivar

POST /api/v1/sdk/deactivate con la clave secreta y X-Blipit-Instance. Cuerpo (opcional): released_by (quién desconectó, por ejemplo un correo). Elimina la vinculación de esta instalación con el proyecto para que otra base de datos pueda conectar la clave, y registra key.instance_released en el registro de auditoría. Responde 200 {released: true}, o 200 {released: false} cuando esta instalación no estaba vinculada, así que repetirla es seguro. 400 si falta X-Blipit-Instance, 401 para una clave desconocida, 403 para una clave pública o una instalación vinculada a otro proyecto. Después, las solicitudes con esa instancia reciben 403 hasta que vuelva a activarse.

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"}'

3Configuración

GET /api/v1/sdk/config con la clave secreta y X-Blipit-Instance. Responde {public_key, features, sdk, odoo}. Consúltalo de vez en cuando (Odoo lo hace cada diez minutos) para detectar un cambio de plan o una nueva clave pública.

4Contactos

PUT /api/v1/sdk/contacts con la clave secreta y X-Blipit-Instance. Cuerpo {companies: [{id, name, people: [{id, name, email}]}]}. Las personas distintas cuentan frente a las plazas del plan junto con miembros, invitaciones y reglas de correo. Responde 200 {used, seats, plan}, o 409 {reason: 'seats_exceeded', seats, used, plan} cuando la lista añadiría personas por encima de las plazas; una lista que solo se reduce siempre se acepta.

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" }] }
  ]
}

Conviene saber

  • Tras la activación, cada petición desde esa instalación debe llevar X-Blipit-Instance; una discrepancia recibe 403 'this key is bound to a different instance'.
  • Una vez vinculada, la vinculación solo cambia mediante la desactivación (desde la propia instalación) o desde el panel de Blipit.

¿Atascado? Escribe a support@blipit.io. Las claves y el id de cada proyecto están en Claves API en app.blipit.io.