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

# إدارة مفاتيح واجهة برمجة تطبيقات

> يوفّر ClickHouse Cloud واجهة برمجة تطبيقات تعتمد على OpenAPI، وتتيح لك إدارة حسابك وبعض جوانب خدماتك برمجيًا.

export const Image = ({img, alt, size = "lg"}) => {
  const normalizedSize = ["sm", "md", "lg"].includes(size) ? size : "lg";
  return <div className={`ch-image-${normalizedSize}`}>
      <Frame>
        <img src={img} alt={alt} />
      </Frame>
    </div>;
};

يوفّر ClickHouse Cloud واجهة برمجة تطبيقات تعتمد على OpenAPI، ما يتيح لك إدارة حسابك وبعض جوانب خدماتك برمجيًا.

<Note>
  يغطي هذا المستند واجهة برمجة تطبيقات ClickHouse Cloud. للاطلاع على نقاط نهاية واجهة برمجة تطبيقات قاعدة البيانات، يُرجى مراجعة [Cloud Endpoints API](/docs/ar/products/cloud/guides/sql-console/query-endpoints)
</Note>

<Steps>
  <Step title="افتح صفحة مفاتيح واجهة برمجة تطبيقات">
    يمكنك استخدام علامة التبويب **مفاتيح واجهة برمجة تطبيقات** في القائمة اليسرى لإنشاء مفاتيح واجهة برمجة تطبيقات وإدارتها.

    <Image img="https://mintcdn.com/private-7c7dfe99/REHSqgCLT_igIuJP/images/cloud/manage/openapi1.webp?fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=4b5e224e02e9995b15f410c0b53cc5e7" size="sm" alt="علامة التبويب مفاتيح واجهة برمجة تطبيقات" border width="433" height="472" data-path="images/cloud/manage/openapi1.webp" />
  </Step>

  <Step title="ابدأ بإنشاء مفتاح واجهة برمجة تطبيقات">
    ستعرض صفحة **مفاتيح واجهة برمجة تطبيقات** في البداية مطالبةً بإنشاء أول مفتاح واجهة برمجة تطبيقات لك، كما هو موضح أدناه. بعد إنشاء مفتاحك الأول، يمكنك إنشاء مفاتيح جديدة باستخدام زر `New API Key` الذي يظهر في الزاوية العلوية اليسرى.

    <Image img="https://mintcdn.com/private-7c7dfe99/REHSqgCLT_igIuJP/images/cloud/manage/openapi2.webp?fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=3ad9d02d51c9ac4c8b0649027ccf61ec" size="md" alt="صفحة مفاتيح واجهة برمجة تطبيقات" border width="1036" height="466" data-path="images/cloud/manage/openapi2.webp" />
  </Step>

  <Step title="كوّن مفتاح واجهة برمجة تطبيقات">
    حدّد اسم المفتاح وأذوناته ووقت انتهاء صلاحيته.

    <Note>
      تتوافق الأذونات مع [الأدوار المعرّفة مسبقًا](/docs/ar/products/cloud/reference/security/console-roles) في ClickHouse Cloud. يمتلك دور المطوّر أذونات قراءة فقط للخدمات المعيّنة، بينما يمتلك دور المسؤول أذونات كاملة للقراءة والكتابة.
    </Note>

    <Tip>
      **Query API Endpoints**

      لاستخدام مفاتيح واجهة برمجة تطبيقات مع [Query API Endpoints](/docs/ar/products/cloud/guides/sql-console/query-endpoints)، اضبط Organization Role على `Member` كحد أدنى، وامنح Service Role إمكانية الوصول إلى `Query Endpoints`.
    </Tip>

    <Image img="https://mintcdn.com/private-7c7dfe99/C7EtYbvQvbHPGmL5/images/cloud/manage/openapi3.png?fit=max&auto=format&n=C7EtYbvQvbHPGmL5&q=85&s=d85d50665cb229cce53ba16a82a27cd1" size="md" alt="نموذج إنشاء مفتاح واجهة برمجة تطبيقات" border width="661" height="410" data-path="images/cloud/manage/openapi3.png" />
  </Step>

  <Step title="أضف عناوين IP المسموح بها">
    لتقييد العملاء الذين يمكنهم استخدام مفتاح واجهة برمجة تطبيقات، انتقل إلى قسم **Allow access to this API Key** وحدّد **Specific locations**. أدخل عنوان IP أو نطاق CIDR، مثل `203.0.113.1` أو `203.0.113.0/24`، ثم أضف إدخالات أخرى حسب الحاجة.

    تلتزم Query API Endpoints بقوائم السماح لعناوين IP على مستوى مفتاح واجهة برمجة تطبيقات. ونظرًا لأن الطلبات تُمرَّر عبر وكيل من داخل بنية ClickHouse التحتية، فلا تنطبق قوائم السماح لعناوين IP على مستوى الخدمة. راجع [IP Access Control](/docs/ar/cloud/features/query-api-endpoints#ip-access-control) لمزيد من التفاصيل.

    <Image img="https://mintcdn.com/private-7c7dfe99/A68-kVUDkVcT2W3b/images/cloud/guides/query-endpoints/specific-locations.webp?fit=max&auto=format&n=A68-kVUDkVcT2W3b&q=85&s=db3d75c39aa5c3e73bc0d23dad7ae25c" size="md" alt="عناوين IP المسموح بها والمكوّنة لمفتاح واجهة برمجة تطبيقات" border width="1336" height="1740" data-path="images/cloud/guides/query-endpoints/specific-locations.webp" />

    انقر على **Generate API Key** عند الانتهاء من تكوين المفتاح.
  </Step>

  <Step title="احفظ بيانات اعتماد مفتاح واجهة برمجة تطبيقات">
    ستعرض الشاشة التالية معرّف المفتاح وسرّه. انسخ هاتين القيمتين واحفظهما في مكان آمن، مثل خزنة أسرار. لن تظهر هاتان القيمتان مرة أخرى بعد مغادرة هذه الشاشة.

    <Image img="https://mintcdn.com/private-7c7dfe99/REHSqgCLT_igIuJP/images/cloud/manage/openapi4.webp?fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=5872535bb69a2299c88f38c627ead497" size="md" alt="تفاصيل مفتاح واجهة برمجة تطبيقات" border width="653" height="271" data-path="images/cloud/manage/openapi4.webp" />
  </Step>

  <Step title="صادِق طلبات واجهة برمجة تطبيقات">
    تستخدم واجهة برمجة تطبيقات ClickHouse Cloud [HTTP Basic Authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication) للتحقق من صحة مفاتيح واجهة برمجة تطبيقات. إليك مثالًا على كيفية استخدام مفاتيح واجهة برمجة تطبيقات لإرسال طلبات إلى واجهة برمجة تطبيقات ClickHouse Cloud باستخدام `curl`:

    ```bash theme={null}
    $ KEY_ID=mykeyid
    $ KEY_SECRET=mykeysecret

    $ curl --user $KEY_ID:$KEY_SECRET https://api.clickhouse.cloud/v1/organizations
    ```
  </Step>

  <Step title="أدر مفاتيح واجهة برمجة تطبيقات الحالية">
    عند العودة إلى صفحة **مفاتيح واجهة برمجة تطبيقات**، سترى اسم المفتاح، وآخر أربعة أحرف من معرّف المفتاح، والأذونات، والحالة، وتاريخ انتهاء الصلاحية، والمنشئ. يمكنك من هذه الشاشة تعديل اسم المفتاح وأذوناته وتاريخ انتهاء صلاحيته. كما يمكنك أيضًا تعطيل المفاتيح أو حذفها منها.

    <Note>
      يُعد حذف مفتاح واجهة برمجة تطبيقات إجراءً نهائيًا. وستفقد أي خدمات تستخدم هذا المفتاح إمكانية الوصول إلى ClickHouse Cloud فورًا.
    </Note>

    <Image img="https://mintcdn.com/private-7c7dfe99/REHSqgCLT_igIuJP/images/cloud/manage/openapi5.webp?fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=e81ed237b99933a115f931acc919c8f8" size="md" alt="صفحة إدارة مفاتيح واجهة برمجة تطبيقات" border width="1092" height="335" data-path="images/cloud/manage/openapi5.webp" />
  </Step>
</Steps>

<div id="endpoints">
  ## نقاط النهاية
</div>

للاطّلاع على تفاصيل نقاط النهاية، راجِع [مرجع واجهة برمجة التطبيقات](/docs/ar/products/cloud/api-reference/organization/get-list-of-available-organizations).
استخدم مفتاح واجهة برمجة التطبيقات والسرّ الخاص بها مع عنوان URL الأساسي `https://api.clickhouse.cloud/v1`.