API-referentie
SDK-activatie, deactivatie, config en contacten
Endpoint POST /api/v1/sdk/activate, POST /api/v1/sdk/deactivate, GET /api/v1/sdk/config, PUT /api/v1/sdk/contacts
De Odoo-module gebruikt deze vier aanroepen. Elke server-side integratie die binding van één sleutel per installatie, de publieke sleutel en de planfuncties wil, kan ze op dezelfde manier gebruiken.
1Activeren
POST /api/v1/sdk/activate met de geheime sleutel. Body: instance_id (verplicht, 8 tot 128 tekens; een stabiele fingerprint van de installatie), base_url, platform, platform_version, terms_version, accepted_by (wie de Voorwaarden heeft geaccepteerd). Antwoordt 200 {project, org, enabled, public_key, features: {security_monitoring, plan, seats}}; seats is null voor onbeperkt. 409 {reason: 'instance_bound_elsewhere'} als deze installatie al aan een ander project rapporteert; 409 {reason: 'project_has_instance'} als deze sleutel al bij een andere installatie hoort.
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"}'2Deactiveren
POST /api/v1/sdk/deactivate met de geheime sleutel en X-Blipit-Instance. Body (optioneel): released_by (wie de verbinding verbrak, bijvoorbeeld een e-mailadres). Verwijdert de binding van deze installatie aan het project zodat een andere database de sleutel kan koppelen, en schrijft key.instance_released naar het auditlog. Antwoordt 200 {released: true}, of 200 {released: false} als deze installatie niet gebonden was, dus herhalen is veilig. 400 als X-Blipit-Instance ontbreekt, 401 bij een onbekende sleutel, 403 bij een publieke sleutel of een installatie die aan een ander project gebonden is. Daarna krijgen requests met die instantie 403 tot ze opnieuw wordt geactiveerd.
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"}'3Config
GET /api/v1/sdk/config met de geheime sleutel en X-Blipit-Instance. Antwoordt {public_key, features, sdk, odoo}. Vraag het af en toe op (Odoo doet dat elke tien minuten) om een planwijziging of een nieuwe publieke sleutel op te merken.
4Contacten
PUT /api/v1/sdk/contacts met de geheime sleutel en X-Blipit-Instance. Body {companies: [{id, name, people: [{id, name, email}]}]}. Afzonderlijke personen tellen mee voor de seats van het plan, samen met leden, uitnodigingen en e-mailregels. Antwoordt 200 {used, seats, plan}, of 409 {reason: 'seats_exceeded', seats, used, plan} als de lijst personen boven de seats zou toevoegen; een lijst die alleen krimpt wordt altijd geaccepteerd.
{
"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" }] }
]
}Goed om te weten
- Na activatie moet elk request van die installatie X-Blipit-Instance dragen; een mismatch krijgt 403 'this key is bound to a different instance'.
- Eenmaal gebonden verandert de binding alleen via deactiveren (vanuit de installatie zelf) of via het Blipit-dashboard.
Kom je er niet uit? Mail support@blipit.io. Sleutels en het project-id van elk project staan onder API-sleutels in app.blipit.io.