Suede
في هذه الصفحة

المصادقة

آخر تحديث

تصادق واجهة بحث Suede باستخدام مفتاح API من نوع bearer. يجب أن تحمل كلّ طلب مفتاحك في ترويسة Authorization.

إنشاء مفتاح

أنشئ المفاتيح وأدِرها في حساب Suede خاصّتك من الإعدادات → التكامل → مفاتيح API:

  1. أدخل اسمًا للمفتاح، كي تتعرّف عليه لاحقًا.
  2. انقر إنشاء. يُعرض المفتاح الكامل مرّةً واحدة — انسخه فورًا واحفظه في مكان آمن.
  3. بعد ذلك لا يُعرض سوى صيغة مُقنَّعة (suede_live_abc123…wxyz). لا يخزّن Suede المفتاح الخام أبدًا، لذا لا يمكن استرجاعه مرّةً أخرى. وإذا فقدت مفتاحًا، فاسحَبه وأنشئ آخر.

اسحب أي مفتاح في أي وقت من الشاشة نفسها؛ والمفتاح المسحوب يتوقّف عن العمل فورًا.

صيغة المفتاح

يبدو المفتاح هكذا:

TEXT
suede_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

يبدأ بالبادئة suede_live_، متبوعةً بسرّ عشوائي. عامِل المفتاح كأنّه كلمة مرور — فأي شخص يحوزه يستطيع البحث على حساب رصيد حسابك. أبقِه على الخادم؛ ولا تضمّنه أبدًا في كود من جهة العميل، أو في تطبيقات الجوّال، أو في المستودعات العامّة.

ترويسة Authorization

أرسل المفتاح بوصفه رمزًا مميّزًا من نوع bearer في كلّ طلب:

TEXT
Authorization: Bearer suede_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

إجراء طلب مُصادَق عليه

cURL
curl "https://api.suede.io/v1/search?q=hello+world" \
  -H "Authorization: Bearer $SUEDE_API_KEY"
C#
using var http = new HttpClient();
http.DefaultRequestHeaders.Authorization =
    new("Bearer", Environment.GetEnvironmentVariable("SUEDE_API_KEY"));
var json = await http.GetStringAsync("https://api.suede.io/v1/search?q=hello+world");
Console.WriteLine(json);
JavaScript
const res = await fetch("https://api.suede.io/v1/search?q=hello+world", {
  headers: { Authorization: `Bearer ${process.env.SUEDE_API_KEY}` },
});
console.log(await res.json());

النطاقات

المفتاح المُنشأ في إعدادات حسابك يحمل نطاق search، الذي يمنح الوصول إلى جميع نقاط نهاية البحث في v1 وإلى الاستخدام. أمّا الطلب المُقدَّم بمفتاح يفتقر إلى النطاق المطلوب فيُرفض بـHTTP 403 و type: insufficient_scope — راجع الأخطاء.

فشل المصادقة

المفتاح المفقود أو المُشوَّه أو غير الصالح أو المسحوب يعيد HTTP 401:

JSON
{ "error": { "type": "unauthorized", "message": "Provide a valid API key as a Bearer token.", "request_id": "…" } }

الخطوات التالية

هل كانت هذه الصفحة مفيدة؟