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

المصادقة

كل استدعاء لواجهة API العامة يحمل بيانات اعتماد واحدة في ترويسة Authorization. وهي نوعان، ويقدمان بالطريقة نفسها.

  1. افتح شارك واذهب إلى الإعدادات.

  2. افتح قسم المطورون.

  3. ابحث عن بطاقة مفتاح API. المفتاح مخفي؛ وإظهار يعرضه ونسخ يضعه في حافظتك.

والمفتاح ملك المؤسسة لا ملكك شخصيًا. فكل من يستدعي به يتصرف بصفة المؤسسة كلها.

ضع المفتاح خامًا في ترويسة Authorization. ولا توجد بادئة Bearer:

Terminal window
curl -H "Authorization: your-api-key" \
https://dash.sharek.app/api/public/v1/is-connected

والمفتاح العامل يجيب:

{ "connected": true }

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

إن كنت تبني منتجًا يجدول نيابةً عن حسابات شارك أخرى، فلا تطلب منهم مفتاح API الخاص بهم. أنشئ تطبيق OAuth بدلًا من ذلك وبادل رمز التفويض برمز وصول. وتلك الرموز مسبوقة بـ pos_ وتذهب في الترويسة نفسها:

Terminal window
curl -H "Authorization: pos_your_oauth_token" \
https://dash.sharek.app/api/public/v1/integrations

ورمز OAuth يصل إلى العمليات نفسها تمامًا التي يصل إليها مفتاح API. والتدفق كاملًا في تطبيقات OAuth.

الأربعة كلها 401 بجسم msg. والرسالة تخبرك أي مرحلة رفضتك:

الاستجابة المعنى
{"msg": "No API Key found"} لا ترويسة Authorization أصلًا.
{"msg": "Invalid API key"} أرسلت ترويسة، لكن لا مؤسسة تملك ذلك المفتاح. ابحث عن Bearer شاردة، أو مسافة، أو مفتاح تم تدويره.
{"msg": "Invalid OAuth token"} بدأت القيمة بـ pos_ لكنها لا تطابق رمزًا صالحًا. فقد يكون سحب، أو حذف تطبيقه.
{"msg": "No subscription found"} بيانات الاعتماد صالحة، لكن المؤسسة بلا اشتراك فعال يتيح الوصول إلى API.

بطاقة مفتاح API فيها زر تدوير المفتاح. والتدوير يسري فورًا: فالمفتاح القديم يتوقف عن العمل لحظة إصدار الجديد.

وكل ما يحمل المفتاح القديم يتوقف عن العمل دفعة واحدة، فحدثه كله في الوقت نفسه: السكربتات والمهام المجدولة، وأداة CLI (SHAREK_API_KEY أو sharek auth:login جديد)، وأي إعداد لعميل MCP، وبيانات اعتمادك في n8n.

وتدوير مفتاح API لا يؤثر في رموز OAuth التي تبدأ بـ pos_. فتلك تسحب من الإعدادات ← التطبيقات ← التطبيقات المصرح لها بدلًا من ذلك.

القيم النائبة في هذه الصفحات

Section titled “القيم النائبة في هذه الصفحات”

كل مثال في هذا الموقع يستخدم بيانات اعتماد وهمية بوضوح: your-api-key لمفاتيح API وpos_your_oauth_token لرموز OAuth. استبدلها بقيمك عند التنفيذ، ولا تضع القيم الحقيقية في أي شيء تشاركه.