إنتقل إلى المحتوى الرئيسي

المصادقة

يستخدم ArchiCore مفاتيح API للمصادقة.

الحصول على مفتاح API​

  1. سجل الدخول إلى ArchiCore
  2. اذهب إلى الإعدادات → المطور
  3. انقر على إنشاء مفتاح API
  4. انسخ واحفظ مفتاحك بشكل آمن
warning

تُعرض مفاتيح API مرة واحدة فقط. احفظها بشكل آمن!

استخدام مفتاح API​

قم بتضمين المفتاح في رأس Authorization:

curl -H "Authorization: Bearer sk_live_xxxxx" \
  https://api.archicore.io/api/v1/projects

أو كمعامل استعلام (غير موصى به):

curl "https://api.archicore.io/api/v1/projects?api_key=sk_live_xxxxx"

أنواع المفاتيح​

البادئةالنوعالوصف
sk_live_إنتاجوصول كامل لحسابك
sk_test_اختباروصول محدود، للتطوير

صلاحيات المفتاح​

ترث مفاتيح API الصلاحيات من مستوى حسابك:

الصلاحيةمجانيProEnterprise
قراءة المشاريع✓✓✓
إنشاء المشاريع✓✓✓
التحليل✓✓✓
Webhooks-✓✓
وصول الفريق--✓

إلغاء المفاتيح​

لإلغاء مفتاح API:

  1. اذهب إلى الإعدادات → المطور
  2. ابحث عن المفتاح في القائمة
  3. انقر على إلغاء

تتوقف المفاتيح الملغاة عن العمل فوراً.

أفضل ممارسات الأمان​

  1. لا تقم أبداً بحفظ مفاتيح API في نظام التحكم بالإصدارات
  2. استخدم متغيرات البيئة لتخزين المفاتيح
  3. قم بتدوير المفاتيح بانتظام (موصى به: كل 90 يوماً)
  4. استخدم مفاتيح الاختبار للتطوير
  5. راقب الاستخدام في لوحة التحكم

متغيرات البيئة​

# .env (أضف إلى .gitignore!)
ARCHICORE_API_KEY=sk_live_xxxxx
const client = new ArchiCore({
  apiKey: process.env.ARCHICORE_API_KEY
});

OAuth (قريباً)​

دعم OAuth 2.0 مخطط لتكاملات الفريق.