تخطَّ إلى المحتوى
Documentation

المصادقة والمفاتيحAPI

API Gatewayيقبل مفاتيحCHAMPREPAPI محددة النطاق لتكامل الخوادم و الأتمتة. تُستخدم جلسات الحساب المستندة إلى المتصفح لإدارة المفاتيح، ولكن يجب على التكامل المخصص مصادقة طلبات الخدمة الخاصة به باستخدام مفتاحAPI .

  1. فتح API المفاتيح.
  2. اختر اسمًا يحدد حمل العمل والبيئة.
  3. بالنسبة لكل خدمة، اختر مستوى وصول، ثم قم بتضييق نطاقه ليقتصر على النطاقات التي يحتاجها عبء العمل.
  4. أضف قائمة عناوين IP المسموح بها عندما يكون لحمل العمل عناوين صادرة ثابتة.
  5. انسخ المفتاح مرة واحدة واحفظه في مدير الأسرار أو سلسلة المفاتيح.

لا تقم بإنشاء مفتاح واحد واسع النطاق لكل تطبيق. فالمفاتيح المنفصلة تجعل التناوب، ومراجعة التدقيق، والاستجابة للحوادث أكثر أمانًا.

Authorization: Bearer YOUR_API_KEY

للحصول على أمثلة على شل، احتفظ بالقيمة في متغير بيئة:

Terminal window
curl --fail-with-body \
--header "Authorization: Bearer $CHAMPREP_TOKEN" \
https://api.champrep.com/v1/auth/whoami

لا تضع مفتاحًا في عنوان URL، أو معلمة استعلام، أو حزمة JavaScript للواجهة الأمامية، أو تطبيق جوال، أو سطر سجل، أو حدث تحليلي.

تقوم شاشة API«المفاتيح» بتجميع الخدمات في أربعة مجالات: مساحة العمل، الاتصال، المطور، والإدارة. لكل خدمة، اختر مستوى وصول، ثم أضف أو أزل نطاقات فردية إذا كان عبء العمل يتطلب نطاقًا أضيق:

  • لا يوجد: لا يمكن للمفتاح استخدام الخدمة.
  • قراءة: النطاقات الموجودة في عمود «القراءة».
  • قراءة وكتابة: القراءة بالإضافة إلى النطاقات الموجودة في عمود «الكتابة».
  • المسؤول: كل ما سبق بالإضافة إلى النطاقات الموجودة في عمود «الإدارة»، بالنسبة للخدمات التي تحتوي على مفتاح API.

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

الخدمةقراءةالكتابةالمسؤول
Drivedrive:readdrive:write, drive:delete—
المستنداتdocs:read, docs:exportdocs:write, docs:share, docs:delete—
جداول البياناتsheets:read, sheets:exportsheets:write, sheets:share, sheets:delete—
Notesnotes:readnotes:write—
Calendarcalendar:readcalendar:write—
Contactscontacts:readcontacts:write—
Workwork:readwork:write, work:delete—
Formsforms:readforms:write—
Invoiceinvoice:readinvoice:write, invoice:send, invoice:delete—
المخططات التنظيميةcharts:readcharts:write, charts:delete—
Learncourses:readcourses:write—
المدرسة LMSغير متاح عبر APIمفتاح API حتى الآن

الخدمةقراءةالكتابةالمسؤول
Mailmail:readmail:write, mail:send—
Chatchat:readchat:write—
Meetmeet:readmeet:write—
RTCقريبًا. تستخدم RTC APIمفاتيح API للمشروع

الخدمةقراءةالكتابةالمسؤول
CHAMPREP Codecode:read_api, code:read_repository, code:read_registry, code:read_package_registrycode:write_repository, code:write_registry, code:write_package_registrycode:api؛ الاشتراك الاختياري code:admin_mode
CHAMPREP QAqa:readqa:write—
مزرعة Runnerrunner_farm:readrunner_farm:write—
CLI—cli:use—
CHAMPREP AI—ai:chat؛ الاشتراك الاختياري ai:actions, ai:agent—

الخدمةقراءةالكتابةالمسؤول
الأعمالbusiness:read—business:manage
الفوترةbilling:read—billing:manage
المطور APIapi:read—api:manage, webhooks:manage
الملف الشخصيusers:read——

لا تتوفر إدارة المنصة أبدًا لمفتاحAPI ؛ فهي تتطلب وجود مسؤول مسجل الدخول.

  • CHAMPREP Code. كل code: يتطابق نطاقها مع نطاق رمز الوصول الشخصي الذي يحمل نفس الاسم في CHAMPREPCode، ويقوم Code بالتحقق منه في كل نقطة نهاية. code:api هي صلاحية كاملة للقراءة والكتابة لكل ما يمكن لحسابك الوصول إليه في Code، لذا فهي تقع على مستوى «Admin»؛ يُفضل استخدام الصلاحيات الأضيق نطاقًا read_ و write_ النطاقات. تحتاج نقاط نهاية إدارة الكود إلى مفتاح يحتوي على code:admin_mode بالاسم، وحسابًا يكون مسؤولًا عن Code.
  • مزرعة Runner. runner_farm:write تقوم بتسجيل وإدارة المشغلات، والمجموعات، والاتصالات. ولا تقوم أبدًا بشراء أرصدة أو تغيير إعدادات الدفع، كما أنها لا تصدر أبدًا سر الموصل أو رمز المشغل، ولا تستبدلهما، ولا تختبرهما. تتطلب هذه الإجراءات شخصًا مسجلاً للدخول.
  • Docs و Sheets. المشاركة (المتعاونون، مشاركة الروابط، النشر)، الحذف الدائم أو الإزالة، والتصدير، كل منها يحتاج إلى نطاق خاص به. مفتاح يحتوي فقط على docs:write أو sheets:write يمكنها تحرير المحتوى ولكن لا يمكنها مشاركته، أو حذفه، أو تصديره.
  • CHAMPREP AI. ai:agent تتيح CLI وكيل الذكاء الاصطناعي تستخدم الأدوات المحلية وتتضمن ai:chat. ai:actions توافق على أو ترفض الإجراءات التي يقترحها الذكاء الاصطناعي في CHAMPREPخدماتك، ولا شيء غير ذلك.

نطاق البدل * (وصول كامل) تغطي كل خدمة تتضمنها خطتك، بما في ذلك CodeCHAMPREP و Runner Farm و Docs. تتعامل CHAMPREPCode معها على أنها code:api، وهو وصول كامل للقراءة والكتابة. ولا يشمل ai:agent أو code:admin_mode؛ يجب دائمًا تحديدها بالاسم.

احتفظ بالرمز البديل للتكاملات الإدارية الخاضعة لرقابة صارمة، و قلل نطاق مفاتيح الوصول الكامل الحالية إذا لم تكن بحاجة إلى الخدمات الأحدث. يسمح النطاق بفئة معينة من الإجراءات؛ ولا يتجاوز أذونات الخطة أو الدور أو المؤسسة أو المورد.

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

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

قم بمراجعة أسماء المفاتيح ونطاقاتها وقيود عناوين IP ومعلومات آخر استخدام و أنشطة التدقيق بانتظام. احذف المفاتيح غير المستخدمة بدلاً من الاحتفاظ بها لاستخدامها في نصوص برمجية محتملة في المستقبل.

تسجيل الدخول عبر المتصفح و CLIتسجيل الدخول

Section titled “تسجيل الدخول عبر المتصفح و CLIتسجيل الدخول”

champrep auth login يستخدم مسار الموافقة عبر المتصفح للمستخدم على جهاز طرفي. champrep auth token يخزن APIمفتاحًا محدد النطاق للأتمتة. ويحميCLI بيانات الاعتماد المخزنة باستخدام سلسلة المفاتيح الخاصة بنظام التشغيل ويرسل جميع الأوامر الشبكية عبر البوابة.

انظر CLI المصادقة و API مفاتيح الأتمتةCLI لتلك سير العمل.