المصادقة

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

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

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

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

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

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

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

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

الطرفية

export NARWHAL_API_KEY="nw_live_..."

صادِق على طلب

أرسل المفتاح في ترويسة HTTP Authorization باعتباره رمز Bearer. 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 عند طلب المساعدة؛ لا ترسل المفتاح نفسه أبداً.

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

سجّل الدخول وافتح الـ لوحة التحكم لاستبدال مفتاح نشط أو إلغائه. يوقف الاستبدال أو الإلغاء المفتاح القديم فوراً؛ ويُعرض مفتاح الاستبدال مرة واحدة ولا يمكن استعادته لاحقاً.

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

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