API

مفاتيح ArchibotChat API

أنشئ مفاتيح API المُنشأة وانسخها ودوّرها وألغِها، واربط أداة زميل عمل خارجية بنقطة نهاية Archibot العامة.

مسؤولو العملاءأعضاء العملاءمشغّلو المنصة

آخر تحديث 18 يونيو 2026

تتيح لك مفاتيح API استدعاء نقطة نهاية Archibot العامة من النصوص البرمجية وأدوات الوكيل المحلية وعمليات التكامل التي تعمل خارج مساحة عمل مُدارة. وهي منفصلة عن بيانات الاعتماد المخفية التي تشغّل شاشة الدردشة في المتصفح، والتي لا تُعرض أبدًا للمستخدمين.

تقوم مساحات عمل Archibot المُدارة بالفعل بتوفير مفاتيحها الخاصة تلقائيًا. استخدم مفتاح API مُنشأ فقط لأداة وكيل محلية أو امتداد محرر أو إطار عمل مملوك للعميل ينبغي أن يستدعي Archibot كزميل عمل خارجي.

متى تستخدم مفاتيح API

أنشئ مفتاحًا مُنشأً عندما تحتاج إلى:

• استدعاء Archibot من نص برمجي أو مهمة مجدولة.
• ربط أداة وكيل محلية أو امتداد محرر بنقطة النهاية.
• تشغيل عميل متوافق مع OpenAI مقابل نقطة نهاية Archibot.
• ربط إطار عمل مملوك للعميل خارج مساحة العمل بـ Archibot.

للأسئلة التفاعلية، استخدم شاشة الدردشة في المتصفح بدلًا من ذلك. راجع استخدام ArchibotChat.

افتح علامة تبويب مفاتيح API

1. افتح الإعدادات من التنقل الأيسر.
2. حدّد عرض Archibot account.
3. افتح علامة تبويب API Keys.

تقع علامة التبويب في الصف نفسه مع Setup وGit access وCI & Review وSupport وActivity وBilling. إذا لم يكن وصول API مُمكَّنًا للحساب، تعرض علامة التبويب الرسالة API access is not enabled for this account. ويكون زر Create key معطلًا. اطلب من مسؤول العميل أو ISM تمكين بوابة منتج API أولًا. راجع إعداد ArchibotChat.

أنشئ مفتاحًا

1. في علامة تبويب API Keys، اختر Create key.
2. يظهر المفتاح الجديد في أعلى القائمة، وتُعرض قيمته الكاملة مرة واحدة في تنبيه مميز ينص على Copy this key now. It will not be shown again.
3. اختر Copy بجوار قيمة المفتاح.
4. خزّنه في مدير الأسرار المعتمد لديك أو في بيئة التشغيل.

تُسمّى المفاتيح تلقائيًا (على سبيل المثال، Console generated key 1) وتُمنح نطاق api. تُعرض القيمة الأولية في هذا التنبيه فقط. بمجرد مغادرتك علامة التبويب أو إنشاء مفتاح آخر، تبقى بادئة المفتاح وبياناته الوصفية فقط مرئية.

إذا لم يتمكن زر النسخ من الوصول إلى الحافظة لديك، تعرض علامة التبويب Clipboard copy unavailable. حدّد نص المفتاح يدويًا وانسخه قبل الانتقال بعيدًا.

اربط أداة زميل عمل خارجية

تنشئ بطاقة External coworker access نصًا برمجيًا للإعداد جاهزًا للتشغيل حتى لا تضطر إلى تجميع متغيرات البيئة يدويًا.

تعرض البطاقة حقلي مرجع:

أسفل تلك الحقول، تعرض معاينة نصًا برمجيًا للصدفة يصدّر متغيرات بيئة نقطة النهاية والمفتاح ويشغّل أمر زميل عمل نموذجي. عندما تكون قد أنشأت مفتاحًا أو دوّرته للتو، يتضمن النص البرمجي قيمة ذلك المفتاح لمرة واحدة؛ وإلا فإنه يستخدم العنصر النائب <new-api-key>.

1. أنشئ مفتاحًا أو دوّره بحيث يقرأ حقل Key source العبارة New one-time key included.
2. اختر Copy setup في بطاقة External coworker access.
3. الصق النص البرمجي في صدفتك المحلية أو مدير الأسرار أو تكوين الأداة.

يضبط النص البرمجي المتغيرات القياسية المتوافقة مع OpenAI (OPENAI_BASE_URL وOPENAI_API_KEY) إلى جانب متغيرات زميل عمل Archibot بحيث يلتقط كل من العملاء المتوافقين مع OpenAI وأدوات زميل عمل Archibot نقطة النهاية والمفتاح نفسهما. استخدم عنوان URL لنقطة نهاية الإنتاج المُقدَّم من ISM لحسابك بدلًا من استنتاجه من مثال محلي.

استخدم مفتاحًا

استخدم المفتاح كرمز حامل مقابل نقطة نهاية Archibot المتوافقة مع OpenAI.

curl https://chat.example.archibot.cloud/v1/responses \
  -H "Authorization: Bearer $ARCHIBOT_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
    "model": "archibot",
    "input": "Summarize this Archibus request queue export."
  }'

تعيد نقطة النهاية توجيه حقول Responses API المتوافقة مع OpenAI مثل tools وtool_choice وreasoning وmetadata ومحتوى input المنظَّم إلى نقطة نهاية Archibot بعد نجاح فحوصات مفتاح API والرصيد.

للاستجابات المتدفقة، أرسل stream: true:

curl -N https://chat.example.archibot.cloud/v1/responses \
  -H "Authorization: Bearer $ARCHIBOT_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
    "model": "archibot",
    "input": "Draft a short work plan for this Archibus data cleanup.",
    "stream": true
  }'

تعيد الاستجابات المتدفقة دليل الفوترة في ترويسات استجابة X-Archibot-* بدلًا من إعادة كتابة كل جزء حدث.

يستخدم اكتشاف النماذج المتوافق مع OpenAI رمز الحامل نفسه:

curl https://chat.example.archibot.cloud/v1/models \
  -H "Authorization: Bearer $ARCHIBOT_API_KEY"

لا يستهلك اكتشاف النماذج من مخصص الاستخدام لديك.

حدود المعدل

تتمتع مفاتيح API المُنشأة بحد طلبات لكل مفتاح. تتضمن الاستجابات ترويسات X-RateLimit-Limit وX-RateLimit-Remaining وX-RateLimit-Reset. عند تجاوز الحد، تعيد نقطة النهاية 429 مع ترويسة Retry-After.

انتهاء الصلاحية

تنتهي صلاحية مفاتيح API المُنشأة بعد عام واحد من الإنشاء. يعرض كل صف مفتاح تواريخ إنشائه وانتهاء صلاحيته وآخر استخدام له بجوار بادئة المفتاح.

تبقى المفاتيح منتهية الصلاحية مرئية بالاسم والبادئة والبيانات الوصفية حتى تتمكن من تدقيق عمليات التكامل القديمة، لكنها لم تعد قادرة على استدعاء اكتشاف النماذج أو نقطة نهاية الاستجابات. تحدث عمليات رفض المفاتيح منتهية الصلاحية قبل احتساب أي استخدام. دوّر مفتاحًا منتهي الصلاحية لإصدار بديل بالاسم والنطاق نفسيهما، أو ألغِه إذا تم سحب التكامل من الخدمة.

دوّر مفتاحًا

دوّر مفتاحًا عندما ينبغي أن يستمر تكامل في العمل بالاسم والنطاق نفسيهما لكن يجب تغيير قيمة السر.

1. في علامة تبويب API Keys، ابحث عن المفتاح النشط بالاسم أو البادئة.
2. اختر Rotate في صف ذلك المفتاح.
3. انسخ القيمة البديلة من التنبيه لمرة واحدة.
4. حدّث النص البرمجي المتأثر أو إدخال مدير الأسرار أو بيئة التشغيل.

يلغي التدوير المفتاح السابق وينشئ بديلًا بالاسم والنطاق نفسيهما. تُعرض القيمة البديلة مرة واحدة فقط، في التنبيه نفسه المستخدم للمفاتيح الجديدة. يعمل التدوير على الفور؛ ولا يوجد مربع حوار تأكيد منفصل، لذا كن مستعدًا لتحديث التكامل قبل أن تفشل حركة المرور القديمة.

ألغِ مفتاحًا

ألغِ مفتاحًا عندما:

• لم يعد مستخدمًا.
• تم لصقه في دردشة أو بريد إلكتروني أو تذكرة أو مستودع أو مستند مشترك.
• يغادر المالك الفريق.
• يُستبدل التكامل.

1. في علامة تبويب API Keys، ابحث عن المفتاح بالاسم أو البادئة.
2. اختر Revoke في صف ذلك المفتاح.
3. حدّث أو أزل أي نص برمجي أو تكامل اعتمد عليه.

يسري الإلغاء على الفور ولا يوجد مربع حوار تأكيد منفصل، لذا تأكد من أن المفتاح هو الصحيح قبل اختيار Revoke.

الفوترة

تُستهلك مفاتيح API المُنشأة من مخصص استخدام الدردشة وAPI المشترك نفسه المعروض في Billing. ينبغي ألا تستهلك الفحوصات المسبقة الفاشلة والطلبات الأولية المرفوضة الأرصدة؛ يصبح الطلب المتدفق قابلًا للفوترة بمجرد قبول نقطة نهاية Archibot للتدفق. راجع فوترة وأرصدة ArchibotChat.

قواعد الأمان

• لا تثبّت مفاتيح API أبدًا في التحكم بالمصدر.
• لا تلصق مفاتيح API أبدًا في تذاكر الدعم أو المستندات المشتركة.
• استخدم متغيرات البيئة أو مدير الأسرار، وليس القيم المضمّنة.
• استخدم مفتاحًا واحدًا لكل تكامل عندما تستطيع.
• دوّر المفاتيح بانتظام لعمليات التكامل الطويلة الأمد.
• ألغِ مفتاحًا على الفور إذا اشتُبه في تعرّضه.

بيانات اعتماد الدردشة مقابل مفتاح API

لا تطلب من دعم ISM الكشف عن بيانات اعتماد الدردشة المخفية. فهي عن قصد غير مرئية للمستخدم.

أدلة ذات صلة

• إعداد ArchibotChat
• استخدام ArchibotChat
• فوترة وأرصدة ArchibotChat
• نظرة عامة على أمان ArchibotChat
• استخدام البيانات المعتمد في ArchibotChat