المصادقة والمفاتيحAPI
API Gatewayيقبل مفاتيحCHAMPREPAPI محددة النطاق لتكامل الخوادم و الأتمتة. تُستخدم جلسات الحساب المستندة إلى المتصفح لإدارة المفاتيح، ولكن يجب على التكامل المخصص مصادقة طلبات الخدمة الخاصة به باستخدام مفتاحAPI .
إنشاء مفتاح
Section titled “إنشاء مفتاح”- فتح API المفاتيح.
- اختر اسمًا يحدد حمل العمل والبيئة.
- حدد نطاقات الخدمة التي يحتاجها عبء العمل فقط.
- أضف قائمة عناوين IP المسموح بها عندما يكون لحمل العمل عناوين صادرة ثابتة.
- انسخ المفتاح مرة واحدة واحفظه في مدير الأسرار أو سلسلة المفاتيح.
لا تقم بإنشاء مفتاح واحد واسع النطاق لكل تطبيق. فالمفاتيح المنفصلة تجعل التناوب، ومراجعة التدقيق، والاستجابة للحوادث أكثر أمانًا.
إرسال بيانات الاعتماد
Section titled “إرسال بيانات الاعتماد”Authorization: Bearer YOUR_API_KEYللحصول على أمثلة على شل، احتفظ بالقيمة في متغير بيئة:
curl --fail-with-body \ --header "Authorization: Bearer $CHAMPREP_TOKEN" \ https://api.champrep.com/v1/auth/whoamiلا تضع مفتاحًا في عنوان URL، أو معلمة استعلام، أو حزمة JavaScript للواجهة الأمامية، أو تطبيق جوال، أو سطر سجل، أو حدث تحليلي.
كتالوج النطاقات
Section titled “كتالوج النطاقات”تم تجميع النطاقات العامة التالية حسب الخدمة. تعرض لوحة المعلومات النطاقات المتاحة حاليًا للحساب.
| الخدمة | قراءة أو استخدام | الكتابة أو الإدارة |
|---|---|---|
| الهوية | users:read, api:read, cli:use |
api:manage |
| Drive | drive:read |
drive:write, drive:delete |
| Chat | chat:read |
chat:write |
| Calendar | calendar:read |
calendar:write |
| Contacts | contacts:read |
contacts:write |
| Meet | meet:read |
meet:write |
| Notes | notes:read |
notes:write |
| Learn | courses:read |
courses:write |
| CHAMPREP AI | ai:chat |
ai:chat |
mail:read |
mail:write, mail:send |
|
| Work | work:read |
work:write, work:delete |
| Invoice | invoice:read |
invoice:write, invoice:send, invoice:delete |
| الأعمال | business:read |
business:manage |
| الفوترة | billing:read |
billing:manage |
| Org Chart | charts:read |
charts:write, charts:delete |
| CHAMPREP QA | qa:read |
qa:write |
| Forms | forms:read |
forms:write |
| Webhooks | — | webhooks:manage |
يمنح نطاق البدل وصولاً واسعاً ويجب حجزه للتكاملات الإدارية الخاضعة لرقابة صارمة. يسمح النطاق بفئة معينة من الإجراءات؛ ولا يتجاوز أذونات الخطة أو الدور أو المؤسسة أو المورد.
دورة حياة المفتاح
Section titled “دورة حياة المفتاح”
التناوب
Section titled “التناوب”قم بإنشاء مفتاح بديل أو إعادة إنشائه، ونشره، وتأكيد أن حمل العمل يستخدمه، ثم قم بإلغاء المفتاح السابق. تجنب إجراء التناوب الذي يترك حمل عمل غير مراقب بدون بيانات اعتماد صالحة.
الإلغاء
Section titled “الإلغاء”قم بإلغاء المفتاح فورًا إذا تم الكشف عنه، أو نسخه إلى نظام غير موثوق به، أو إذا لم يعد ينتمي إلى حمل عمل نشط. يجب أن يُرجع المفتاح الملغى 401 ويجب ألا تُعاد المحاولة إلى ما لا نهاية.
مراجعة
Section titled “مراجعة”قم بمراجعة أسماء المفاتيح ونطاقاتها وقيود عناوين IP ومعلومات آخر استخدام و أنشطة التدقيق بانتظام. احذف المفاتيح غير المستخدمة بدلاً من الاحتفاظ بها لاستخدامها في نصوص برمجية محتملة في المستقبل.
تسجيل الدخول عبر المتصفح و CLIتسجيل الدخول
Section titled “تسجيل الدخول عبر المتصفح و CLIتسجيل الدخول”champrep auth login يستخدم مسار الموافقة عبر المتصفح للمستخدم على جهاز طرفي.
champrep auth token يخزن APIمفتاحًا محدد النطاق للأتمتة. ويحميCLI بيانات الاعتماد المخزنة باستخدام سلسلة المفاتيح الخاصة بنظام التشغيل ويرسل جميع الأوامر الشبكية عبر البوابة.
انظر CLI المصادقة و API مفاتيح الأتمتةCLI لتلك سير العمل.