تفعيل SDK والإعداد وجهات الاتصال

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الإعداد

GET /api/v1/sdk/config بالمفتاح السري وX-Blipit-Instance. يجيب بـ {public_key, features}. استعلم عنه من حين لآخر (يفعل Odoo ذلك كل عشر دقائق) لملاحظة تغيير الخطة أو مفتاح عام جديد.

3جهات الاتصال

PUT /api/v1/sdk/contacts بالمفتاح السري وX-Blipit-Instance. الجسم {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 «this key is bound to a different instance».
• بمجرد الربط، لا يمكن تغيير الارتباط إلا من لوحة تحكم Blipit.