إنشاء رمز API

curl -X POST "https://qcg-api.scanova.io/console/token/" \
  -H "Authorization: Bearer <your_oauth_access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Zapier — production",
    "environment": "zapier",
    "expiry": 365
  }'

{
  "name": "Zapier — production",
  "key": "401f7ac837da42b97f613d789819ff93537bee6a",
  "environment": "zapier",
  "expiry": 365,
  "created_by": {
    "id": 1042,
    "full_name": "Jordan Lee",
    "email": "jordan@example.com"
  },
  "created": "2026-08-16T09:12:33.512000Z",
  "expiry_date": "2027-08-16T09:12:33.512000Z",
  "expired": false,
  "usage_count": 0
}

POST

console

token

curl -X POST "https://qcg-api.scanova.io/console/token/" \
  -H "Authorization: Bearer <your_oauth_access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Zapier — production",
    "environment": "zapier",
    "expiry": 365
  }'

{
  "name": "Zapier — production",
  "key": "401f7ac837da42b97f613d789819ff93537bee6a",
  "environment": "zapier",
  "expiry": 365,
  "created_by": {
    "id": 1042,
    "full_name": "Jordan Lee",
    "email": "jordan@example.com"
  },
  "created": "2026-08-16T09:12:33.512000Z",
  "expiry_date": "2027-08-16T09:12:33.512000Z",
  "expired": false,
  "usage_count": 0
}

ينشئ مفتاح Management API جديدًا. تقع نقطة النهاية هذه على مضيف Scanova API العادي (‏qcg-api.scanova.io) وتُصادَق بنفس الطريقة التي تُصادَق بها أي طلب آخر من لوحة التحكم بعد تسجيل الدخول — رمز وصول OAuth، لا مفتاح Management API.

هذا هو استدعاء Management API الوحيد الذي تقوم به من سياق موثوق باستخدام تسجيل دخولك الخاص، وليس من التكامل الذي سيستخدم المفتاح الناتج. راجع النظرة العامة للاطلاع على البنية الكاملة ذات المضيفين.

الطلب

POST https://qcg-api.scanova.io/console/token/
Authorization: Bearer <your_oauth_access_token>
Content-Type: application/json

معلمات الجسم

string

مطلوب

تسمية مقروءة للبشر للمفتاح، مثل "Zapier — production". تظهر في قائمة المفاتيح بلوحة التحكم لتتمكن من تمييز المفاتيح عن بعضها.

string

افتراضي:"sandbox"

واحد من sandbox، live، zapier، mcp. دائم طوال عمر المفتاح — يحدد حصة الخطة التي تُفحص مع كل طلب يقوم به المفتاح إلى مضيف البيانات، وبالنسبة لمفاتيح zapier/mcp، ترويسة User-Agent التي يجب على العميل المستدعي إرسالها. راجع حصة الخطة للاطلاع على التخطيط الكامل.

integer

افتراضي:"-1"

واحد من -1 (لا ينتهي أبدًا)، 30، 90، أو 365 — عدد الأيام بعد الإنشاء التي يتوقف بعدها المفتاح عن العمل. لا توجد طريقة لتمديد تاريخ انتهاء مفتاح موجود؛ أنشئ مفتاحًا جديدًا بدلًا من ذلك.

curl -X POST "https://qcg-api.scanova.io/console/token/" \
  -H "Authorization: Bearer <your_oauth_access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Zapier — production",
    "environment": "zapier",
    "expiry": 365
  }'

{
  "name": "Zapier — production",
  "key": "401f7ac837da42b97f613d789819ff93537bee6a",
  "environment": "zapier",
  "expiry": 365,
  "created_by": {
    "id": 1042,
    "full_name": "Jordan Lee",
    "email": "jordan@example.com"
  },
  "created": "2026-08-16T09:12:33.512000Z",
  "expiry_date": "2027-08-16T09:12:33.512000Z",
  "expired": false,
  "usage_count": 0
}

حقول الاستجابة

string

مفتاح Management API الخام. هذه هي الاستجابة الوحيدة التي تعيد قيمة المفتاح الكاملة على الإطلاق — لا توجد نقطة نهاية لإظهاره/استرجاعه لاحقًا، لذا خزّنه فورًا.

string | null

طابع الانتهاء المطلق، محسوبًا من created + عدد أيام expiry، أو null عندما تكون expiry هي -1 (لا ينتهي أبدًا).

boolean

ما إذا كان المفتاح قد تجاوز بالفعل expiry_date الخاص به. المفاتيح المنتهية تفشل في المصادقة على مضيف البيانات لكن لا تُحذف تلقائيًا — أزلها صراحة عبر DELETE /console/token/{key}/ إذا أردت إزالتها من القائمة.

integer

عدد الطلبات مدى الحياة التي تم إجراؤها بهذا المفتاح تحديدًا، عبر تاريخه بالكامل. هذا يختلف عن الأرقام الإجمالية على مستوى البيئة (environment) التي تعيدها نقاط نهاية الاستخدام أدناه، والتي تجمع عبر كل مفتاح يشارك تلك البيئة.

سرد الرموز الموجودة

نفس مسار console/token/ يقبل أيضًا GET (بلا نص طلب) لسرد كل مفتاح في الحساب، مُعيدًا نفس شكل استجابة الإنشاء لكل واحد. يمكنك التصفية حسب البيئة: GET /console/token/?environment=live.

كل من إنشاء الرموز وسردها يعيد فحص حصة الخطة باستخدام environment الخاصة بالطلب — حقل الجسم عند الإنشاء، ومعلمة الاستعلام عند السرد، بالقيمة الافتراضية sandbox إذا حُذفت. إذا كانت حصص sandbox وlive مختلفتين في خطتك، مرّر ?environment=live صراحة عند سرد مفاتيح بيئة live، لأن الافتراضي يفحص حصة sandbox بخلاف ذلك.

البدء

واجهة الإدارة — الرموز والاستخدام

واجهة الإدارة — رموز QR

واجهة الإدارة — المجلدات والوسوم

واجهة الإدارة — المستخدمون المشتركون والأدوار

واجهة الإدارة — العملاء المحتملون والنماذج

واجهة الإدارة — التحليلات والخطط

الطلب

معلمات الجسم

حقول الاستجابة

سرد الرموز الموجودة

ذات صلة

التفويضات

الاستجابة

​الطلب

​معلمات الجسم

​حقول الاستجابة

​سرد الرموز الموجودة

​ذات صلة

التفويضات

الاستجابة

الطلب

معلمات الجسم

حقول الاستجابة

سرد الرموز الموجودة

ذات صلة