> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getqr.com/llms.txt
> Use this file to discover all available pages before exploring further.

# المصادقة

> أنشئ مفتاح API وصادِق على طلباتك.

> [!NOTE]
>
> GetQR API في مرحلة تجريبية (beta) ومتاحة لمساحات عمل مختارة. قد تتغير التفاصيل قبل الإصدار العام.

تصادق GetQR API على كل طلب باستخدام مفتاح API الخاص بحسابك. لكل مستخدم مفتاح واحد، ويعمل المفتاح باسمك في مساحة عمل واحدة.

## قبل أن تبدأ

* يجب أن تكون مالك مساحة العمل أو Editor. لا يمكن لمستخدمي Viewer إنشاء مفتاح API أو استخدامه.
* يجب أن يكون لدى مالك مساحة العمل اشتراك نشط.

## إنشاء مفتاح API

**1. افتح إعدادات حسابك**

افتح إعدادات حسابك وانتقل إلى **API**.

**2. أنشئ المفتاح**

انقر على **Generate API key**.

**3. انسخ المفتاح**

اعرض المفتاح وانسخه. تبدأ المفاتيح بـ `sk_live_`.

يمكنك عرض المفتاح ونسخه مرة أخرى في أي وقت. تعرض الإعدادات أيضًا وقت إنشاء المفتاح وآخر مرة استُخدم فيها.

## مصادقة الطلبات

أرسل المفتاح كرمز Bearer في الترويسة `Authorization` لكل طلب:

```bash theme={null}
curl "https://getqr.com/api/v1/qrs" \
  -H "Authorization: Bearer sk_live_..."
```

| المشكلة | الاستجابة |
| - | - |
| لا توجد ترويسة `Authorization` | `401 unauthorized`: "Missing Authorization header." |
| الترويسة لا تبدأ بـ `Bearer ` | `400 bad_request`: "Misconfigured authorization header. Did you forget to add 'Bearer '?" |
| مفتاح غير معروف أو أُعيد إنشاؤه | `401 unauthorized`: "Unauthorized: Invalid API key." |
| دورك هو Viewer | `403 forbidden`: "API access is not available for this role." |
| اشتراك مالك مساحة العمل غير نشط | `403 forbidden`: "Access denied: This account does not have an active subscription." |
| الواجهة غير مفعّلة لمساحة عملك | `404 not_found`: "This endpoint is not available." |

[فحص الحالة](https://docs.getqr.com/ar/api/endpoints/health.md) هو نقطة النهاية الوحيدة التي تعمل دون مفتاح.

## الوصول والأدوار

* **الأدوار.** لا يمكن إنشاء مفتاح API واستخدامه إلا لمالك مساحة العمل ومستخدمي Editor. لا يمكن ذلك لمستخدمي Viewer.
* **مساحة العمل.** ينتمي كل مفتاح إلى مساحة عمل واحدة، ويُنفَّذ كل طلب في مساحة العمل تلك. لا تحتاج إلى تمرير معرّف مساحة العمل.
* **فحوصات فورية.** يُتحقق من الوصول في كل طلب وفق دورك الحالي واشتراك مالك مساحة العمل. لا يُحتسب اشتراكك الشخصي. إذا تغيّر دورك إلى Viewer أو انتهى اشتراك المالك، تُرجع الطلبات `403` حتى يُستعاد الوصول. لا تحتاج إلى مفتاح جديد.
* **الإزالة.** إذا أُزلت من مساحة العمل، يُحذف مفتاح API الخاص بك. إذا أُضفت مرة أخرى، فأنشئ مفتاحًا جديدًا.

## إعادة إنشاء المفتاح

أعد إنشاء المفتاح إذا تسرّب أو وصل إليه شخص لا ينبغي أن يملكه.

> [!WARNING]
>
> يتوقف مفتاحك الحالي عن العمل فورًا. يتعطل أي تطبيق أو تكامل يستخدمه حتى تحدّثه بالمفتاح الجديد.

**1. انقر على Regenerate**

في إعدادات حسابك، انتقل إلى **API** وانقر على **Regenerate**.

**2. أكّد**

انقر على **Regenerate key**.

**3. حدّث تطبيقاتك**

انسخ المفتاح الجديد واستبدل به القديم في كل مكان تستخدمه فيه.

## حافظ على أمان مفتاحك

تعامل مع المفتاح ككلمة مرور: يستطيع أي شخص يملكه إنشاء رموز QR وتغييرها وحذفها في مساحة عملك.

* احفظه في متغير بيئة أو في مدير أسرار، وليس في الشيفرة المصدرية.
* استدعِ الواجهة من خادمك فقط. لا تضع المفتاح أبدًا في موقع ويب أو تطبيق جوال أو أي شيء آخر يمكن للمستخدمين فحصه.
* شاركه فقط مع المطورين الذين يحتاجون إليه.
* أعد إنشاءه فور اشتباهك في تسرّبه.

## المشكلات الشائعة

> [accordion] أحصل على 401 بمفتاح كان يعمل من قبل
>
> أُعيد إنشاء المفتاح، أو أُزلت من مساحة العمل فحُذف المفتاح. انسخ المفتاح الحالي من إعدادات حسابك، أو أنشئ مفتاحًا جديدًا.

> [accordion] أحصل على 403 في كل طلب
>
> تحقّق من أن دورك هو المالك أو Editor، وأن اشتراك مالك مساحة العمل نشط. يعمل المفتاح مجددًا بمجرد استعادة الوصول.

> [accordion] أحصل على 404 "This endpoint is not available."
>
> الواجهة في مرحلة تجريبية ولم تُفعَّل لمساحة عملك بعد.

> [accordion] لا أرى إعدادات API
>
> تظهر فقط لمالك مساحة العمل ومستخدمي Editor، وفقط في مساحات العمل التي فُعِّلت فيها الواجهة.

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

> [card] [مقدمة عن API](https://docs.getqr.com/ar/api/introduction.md)

> [card] [الأخطاء](https://docs.getqr.com/ar/api/errors.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.