SDK-Aktivierung, Konfiguration und Kontakte

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

Das Odoo-Modul verwendet diese drei Aufrufe. Jede serverseitige Integration, die eine Ein-Schlüssel-pro-Installation-Bindung, den öffentlichen Schlüssel und die Plan-Features möchte, kann sie auf dieselbe Weise nutzen.

1Aktivieren

POST /api/v1/sdk/activate mit dem geheimen Schlüssel. Body: instance_id (erforderlich, 8 bis 128 Zeichen; ein stabiler Fingerprint der Installation), base_url, platform, platform_version, terms_version, accepted_by (wer die Nutzungsbedingungen akzeptiert hat). Antwortet 200 {project, org, enabled, public_key, features: {security_monitoring, plan, seats}}; seats ist null für unbegrenzt. 409 {reason: 'instance_bound_elsewhere'}, wenn diese Installation bereits an ein anderes Projekt meldet; 409 {reason: 'project_has_instance'}, wenn dieser Schlüssel bereits zu einer anderen Installation gehört.

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

2Konfiguration

GET /api/v1/sdk/config mit dem geheimen Schlüssel und X-Blipit-Instance. Antwortet {public_key, features}. Fragen Sie es gelegentlich ab (Odoo tut das alle zehn Minuten), um eine Planänderung oder einen neuen öffentlichen Schlüssel zu bemerken.

3Kontakte

PUT /api/v1/sdk/contacts mit dem geheimen Schlüssel und X-Blipit-Instance. Body {companies: [{id, name, people: [{id, name, email}]}]}. Unterschiedliche Personen zählen zusammen mit Mitgliedern, Einladungen und E-Mail-Regeln gegen die Plätze des Plans. Antwortet 200 {used, seats, plan} oder 409 {reason: 'seats_exceeded', seats, used, plan}, wenn die Liste Personen über die Plätze hinaus hinzufügen würde; eine Liste, die nur kleiner wird, wird immer akzeptiert.

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

Gut zu wissen

  • Nach der Aktivierung muss jeder Request dieser Installation X-Blipit-Instance tragen; eine Abweichung erhält 403 'this key is bound to a different instance'.
  • Einmal gebunden, kann die Bindung nur über das Blipit-Dashboard geändert werden.

Kommen Sie nicht weiter? Schreiben Sie an support@blipit.io. Schlüssel und den genauen DSN jedes Projekts finden Sie unter API-Schlüssel in app.blipit.io.