Karzoun Docs

ستنشئ مفتاحاً، وتستدعي حسابك، وتقرأ قائمة وسوم.

أنشئ مفتاح API

افتح المطوّر ← مفاتيح API (/developer/api-keys). أنشئ مفتاحاً شخصياً، واترك النطاقات التي يسمح بها حسابك، وانسخ السر. يبدأ بـ kz_live_ ويُعرض مرة واحدة.

لا ترفع المفتاح إلى Git ولا تلصقه في شيفرة الواجهة.

انسخ عنوان الواجهة

استبدل YOUR_SUBDOMAIN بالنطاق الفرعي لحسابك. إن كنت تدخل من acme.karzoun.chat فالعنوان هو:

https://acme.api.karzoun.chat/graphql

شغّل هذا الاستعلام

الاستعلام وأمر curl أدناه هما الطلب نفسه.

query {
  tags(page: 1, perPage: 5) {
    data {
      _id
      name
    }
    pagination {
      totalCount
    }
  }
}

curl -X POST 'https://YOUR_SUBDOMAIN.api.karzoun.chat/graphql' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer kz_live_YOUR_API_KEY' \
  -d '{"query":"query { tags(page: 1, perPage: 5) { data { _id name } pagination { totalCount } } }"}'

المفتاح السليم يعيد JSON بهذا الشكل:

{
  "data": {
    "tags": {
      "data": [{ "_id": "…", "name": "VIP" }],
      "pagination": { "totalCount": 12 }
    }
  }
}

قد تكون data قائمة فارغة. هذا يعني أن الطلب نجح. إذا ظهر errors فالمفتاح مفقود أو ملغى، أو الاستعلام لا يطابق المخطط. انظر الأخطاء.

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

المصادقة — المفتاح الشخصي ومفتاح الحساب، وما يُسمح للمفتاح باستدعائه
ترقيم الصفحات — اقرأ بقية القائمة
مرجع GraphQL — كل استعلام وتعديل عام

المخطط الخام، بلا مفتاح، على https://YOUR_SUBDOMAIN.api.karzoun.chat/public-api.graphql.

آخر تعديل في ١١ أغسطس ٢٠٢٦

البداية

أدلة

جرّب

Queries

Mutations

Types

البداية السريعة

التالي

​التالي

التالي