الوصول إلى API (للمطورين)
في باقتي الوكالات والمؤسسات، أنشئ مفاتيح قراءة أو قراءة وكتابة لواجهة API العامة من الإعدادات > التكاملات؛ وتتوقف المفاتيح مؤقتًا حين لا تعود الباقة تتضمن الوصول إلى API.
الإعدادات ← التكاملات (/app/settings/integrations)، بطاقة الوصول إلى API (للمطورين) في أسفل الصفحة. للمالكين والمسؤولين فقط. "اربط OmniBrand بأنظمتك أو Zapier أو Make لإنشاء المنشورات وإضافة جهات الاتصال وقراءة التحليلات تلقائيًا." يتيح المفتاح لبرامجك الاتصال بواجهة OmniBrand العامة بالترويسة Authorization: Bearer ob_live_… ويعرض أسفل البطاقة، عنوان API، العنوان الذي تُرسل إليه هذه الطلبات ("العنوان الذي تستقبل عليه واجهة API العامة الطلبات. أرسل كل طلب إليه مع أحد المفاتيح أعلاه."). والروابط القديمة إلى /app/settings#developer تفتح هذه البطاقة.
الباقات التي تتضمنه
الوصول إلى API جزء من باقتي الوكالات والمؤسسات. في المجانية والبداية والاحترافية، وخلال تجربة الاحترافية لمدة 14 يومًا، تعرض البطاقة فقط "الوصول إلى API متاح في باقة الوكالات." مع رابط عرض الباقات إلى الباقة والاستهلاك؛ ولا يوجد نموذج لإنشاء مفتاح. وتذكر بطاقات الباقات في الباقة والاستهلاك وفي /pricing الوصول إلى API للوكالات والمؤسسات.
عند تغيّر الباقة
- حين ينتقل الحساب إلى باقة لا تتضمن الوصول إلى API (تخفيض الباقة، أو استرداد المبلغ، أو انتهاء تجربة) تُوقف مفاتيحه مؤقتًا: تبقى محفوظة ولا يُحذف شيء، لكن كل طلب يستخدمها يُرفض برسالة (بالإنجليزية) معناها أن الوصول إلى API متاح في باقتي الوكالات والمؤسسات (HTTP 403، الرمز
api_access_not_in_plan). - يصل إلى مالك الحساب بريد واحد، تم إيقاف مفاتيح API مؤقتًا، مع زر عرض الباقات.
- العودة إلى الوكالات أو المؤسسات تعيد تشغيل المفاتيح نفسها خلال دقيقة، ولا حاجة إلى إنشاء مفاتيح جديدة.
- أثناء الإيقاف لا تظهر المفاتيح في القائمة ولا يمكن إنشاؤها أو تدويرها. لإيقاف مفتاح نهائيًا رقِّ الباقة وانقر إلغاء عليه، أو راسل الدعم.
خطوة بخطوة: إنشاء مفتاح
- اكتب اسمًا في اسم المفتاح (مثل: CI bot)، حتى 60 حرفًا، لتعرف لاحقًا ما الذي يستخدمه. بلا اسم (أو باسم من مسافات فقط) لا يُنشئ إنشاء مفتاح شيئًا، وتقول الخانة "اكتب اسمًا للمفتاح، مثل "مزامنة الموقع"." ولا يُنشأ شيء. وتُحذف المسافات قبل الاسم وبعده.
- في صلاحيات المفتاح اختر قراءة فقط (قراءة البيانات) أو قراءة وكتابة (الإنشاء والتعديل أيضًا).
- انقر إنشاء مفتاح.
- يعرض مربع أصفر "مفتاح جديد لـ "(الاسم)". انسخه الآن: يظهر مرة واحدة فقط." والمفتاح كاملًا، مع نسخ (يصبح بعدها تم النسخ) وحفظته الذي يغلق المربع. انسخ المفتاح الآن واحفظه في مكان آمن؛ فـ OmniBrand لا يحفظ إلا بصمته ولا يمكنه عرضه مرة أخرى.
القائمة
يعرض كل مفتاح اسمه وأول أحرفه (ob_live_…) وصلاحيته وآخر استخدام ("آخر استخدام ..." أو "لم يُستخدم") و"ينتهي ..." مع تاريخ انتهائه.
- تدوير: يسأل أولًا: "تدوير "(الاسم)" (البادئة…)؟ تحصل على مفتاح جديد فورًا. يبقى المفتاح الحالي يعمل 24 ساعة ثم يتوقف، فضع المفتاح الجديد في كل مكان يُستخدم فيه القديم قبل ذلك." انقر تدوير المفتاح للمتابعة، أو إلغاء. ويظهر المفتاح الجديد، بالاسم والصلاحية نفسيهما، مرة واحدة في المربع الأصفر نفسه. يبقى المفتاح القديم يعمل 24 ساعة لتنقل تكاملك إليه، ثم يتوقف. وحتى ذلك الحين يبقى في القائمة غير مشطوب، مع "يعمل المفتاح القديم حتى [التاريخ والوقت]" وزر إلغاء.
- إلغاء: يسأل "هل تريد إلغاء المفتاح (الاسم) (البادئة…)؟ يتوقف كل ما يستخدمه عن العمل فورًا، ولا يمكن إعادة تشغيل مفتاح ملغى." عنوان النافذة إلغاء المفتاح؟؛ انقر إلغاء المفتاح ليتوقف المفتاح فورًا، أو إلغاء للإبقاء عليه. ويعمل أيضًا على المفتاح القديم خلال ساعاته الأربع والعشرين بعد التدوير: إن دوّرت المفتاح لأنه تسرّب فانقر إلغاء على المفتاح القديم ليتوقف الآن. تبقى المفاتيح الملغاة (والمفاتيح المدوّرة بعد انتهاء ساعاتها الأربع والعشرين) في القائمة مشطوبة، مع شارة حمراء "أُلغي في (التاريخ)" تحت الاسم.
لمن يعود المفتاح
- المفتاح يعود لمن أنشأه، ويشمل مساحات العمل التي يكون فيها مالكًا أو مسؤولًا لحظة الإنشاء.
- لا يعمل إلا ما دام منشئه مالكًا أو مسؤولًا نشطًا في كل مساحة يشملها. إن أُزيل أو خُفّض دوره أو عُطّل حسابه تفشل الطلبات برسالة (بالإنجليزية) معناها أن منشئ المفتاح لم يعد يدير مساحات عمله، فاطلب من مسؤول حالي إصدار مفتاح جديد.
- لا ترى ولا تدوّر ولا تلغي إلا المفاتيح التي تدير أنت مساحات عملها. في حساب فيه مساحات لعملاء كثيرين لا يرى مسؤول عميل مفاتيح عميل آخر.
إذا حدث خطأ
- رسالة "This API key has expired": تدوم المفاتيح سنة واحدة. انقر تدوير عليه في الوصول إلى API (للمطورين) (أو أنشئ مفتاحًا جديدًا) وحدّث تكاملك.
- رسالة "Invalid or revoked API key": أُلغي المفتاح، أو انتهت مهلة التدوير (24 ساعة)، أو نُسخ ناقصًا.
- لا يستطيع مفتاح API إنشاء مفاتيح أخرى أو تدويرها أو إلغاءها؛ هذا للأشخاص المسجلين فقط.
- رسالة "This endpoint is not available to API keys": هذا الطلب للأشخاص المسجلين فقط مهما كانت صلاحية المفتاح. لا يصل المفتاح أبدًا إلى: الأعضاء والدعوات (
/workspaces/{id}/membersو/workspaces/{id}/invitationsو/invitations)، وإنشاء مساحة عمل أو إعادة تسميتها أو أرشفتها أو إلغاء أرشفتها أو حذفها، والـ Webhooks الصادرة (/workspaces/{id}/webhooks)، والتصدير، وسلسلة الموافقات، وجداول التقارير، وربط قناة أو فصلها أو إزالتها أو تغيير مالكها، وشعار المؤسسة وملفها التعريفي وخطوات البدء، وكل ما يقع تحت /auth أو /billing أو /admin أو /tenant/api-keys. نفّذ هذه من التطبيق وأنت مسجّل الدخول كمالك أو مسؤول. يغطي الذكاء الاصطناعي عبر المفتاح نص المنشور والأفكار والصور وإعادة الصياغة والوسوم والنص البديل وفرز الرسائل، بحد 10 طلبات في الدقيقة و300 في اليوم لكل مفتاح (رسالة "API key AI rate limit exceeded")؛ أما الفيديو واستوديو الذكاء الاصطناعي وبقية أدوات الذكاء الاصطناعي فللأشخاص المسجلين فقط. ولا يغيّر مهام مراقبة السوق ومصادرها وإعداداتها والروبوتات وإعدادات مساحة العمل مثل الفرز التلقائي إلا شخص مسجّل الدخول. ويحتاج تشغيل الدعم أو إيقافه وتغيير تصنيفه بالذكاء الاصطناعي وقراءة صحة العلامة بالذكاء الاصطناعي إلى شخص مسجّل الدخول أيضًا، ولا يتضمن التقرير المطلوب بمفتاح ملخصًا بالذكاء الاصطناعي إلا إذا كان موجودًا من قبل.