المصادقة

استخدم مفتاح Bearer واحدًا لطلبات REST وMCP من Narwhal.

يتطلب كل طلب بيانات من Narwhal مفتاح API. وتظل واجهة الحالة وOpenAPI وواجهات التوثيق العامة متاحة.

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

أنشئ حسابًا باستخدام Google أو GitHub. يُنشأ مفتاح مجاني بعد تسجيل الدخول ويُعرض مرة واحدة.

الـ لوحة التحكم تعرض حسابك الذي سجّلت الدخول إليه وروابط الإعداد. ولا تُعرض المفاتيح الكاملة إلا مرة واحدة.

خزّن المفتاح بأمان

يُعاد المفتاح مرة واحدة عند إصداره. يخزن Narwhal قيمة تحقق أحادية الاتجاه فقط، لا المفتاح نفسه، لذلك لا يمكن عرض المفتاح مرة أخرى.

احتفظ به في مدير أسرار أو متغير بيئة محلي.
لا تُدرجه في سجل الإصدارات، ولا تلصقه في السجلات، ولا تضعه في عنوان URL.
لا تكشفه في شفرة المتصفح.

الطرفية

export NARWHAL_API_KEY="nw_live_..."

صادِق على طلب

أرسل المفتاح في ترويسة HTTP المسماة Authorization باستخدام آلية Bearer. تستخدم REST وMCP الترويسة نفسها.

طلب REST مصادق عليه

curl --request GET \
  --url https://api.narwhalapi.com/v1/economics/USA/cpi \
  --header "Authorization: Bearer $NARWHAL_API_KEY"

تعامل مع مفتاح مرفوض

يعيد المفتاح المفقود أو المشوه أو غير النشط أو غير المعروف 401 مع الرمز invalid_api_key و WWW-Authenticate: Bearer الترويسة.

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

الاسترداد والتدوير

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

إذا فقدت الوصول إلى جلسة الحساب، فتوقف عن استخدام أي مفتاح مكشوف، ثم تواصل مع Narwhal API للحصول على المساعدة.

تابع باستخدام البدء السريع بعد تخزين المفتاح بأمان.