> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-revert-104359-revert-104251-parquet-single.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# الوصول البرمجي إلى واجهة برمجة تطبيقات باستخدام Postman

> سيساعدك هذا الدليل على اختبار واجهة برمجة تطبيقات ClickHouse Cloud باستخدام Postman

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 باستخدام [Postman](https://www.postman.com/product/what-is-postman/).
يتوفر تطبيق Postman للاستخدام عبر متصفح الويب، أو يمكن تنزيله على جهاز سطح المكتب.

<div id="create-an-account">
  ### أنشئ حسابًا
</div>

* تتوفر حسابات مجانية على [https://www.postman.com](https://www.postman.com).

<Image img="https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman1.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=a83e85bab1c9478ae60b28debee354b2" size="md" alt="موقع Postman" border width="1621" height="1011" data-path="images/cloud/manage/postman/postman1.webp" />

<div id="create-a-workspace">
  ### أنشئ مساحة عمل
</div>

* سمِّ مساحة العمل وحدِّد مستوى الظهور.

<Image img="https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman2.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=05d9395d9bbd3f2e46bd83afd7102caa" size="md" alt="إنشاء مساحة عمل" border width="784" height="760" data-path="images/cloud/manage/postman/postman2.webp" />

<div id="create-a-collection">
  ### إنشاء مجموعة
</div>

* أسفل "Explore" في القائمة أعلى اليسار، انقر على "Import":

<Image img="https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman3.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=86ce94530dc6d7cb5da51ce1b51114d5" size="md" alt="Explore > Import" border data-og-width="1317" width="1317" data-og-height="647" height="647" data-path="images/cloud/manage/postman/postman3.webp" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman3.webp?w=280&fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=7b18c9b2a26eca9dcbdd780ac11882d4 280w, https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman3.webp?w=560&fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=142cb6eb42e69d071edf36fa467c1f4f 560w, https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman3.webp?w=840&fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=6c58fb4c3beef4015530c82557d66ba2 840w, https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman3.webp?w=1100&fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=d81c9c9658a3ba004379eb80de219b2b 1100w, https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman3.webp?w=1650&fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=b7209dadddebba5f4fbacf92266bb066 1650w, https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman3.webp?w=2500&fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=beb45a440573031b4f91ba9746648379 2500w" />

* ستظهر نافذة منبثقة:

<Image img="https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman4.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=a102d3495baea7db3f8415851922adfc" size="md" alt="إدخال عنوان URL لواجهة برمجة التطبيقات" border width="659" height="471" data-path="images/cloud/manage/postman/postman4.webp" />

* أدخل عنوان واجهة برمجة التطبيقات: "[https://api.clickhouse.cloud/v1](https://api.clickhouse.cloud/v1)" ثم اضغط على 'Enter':

* حدِّد "Postman Collection" بالنقر على زر "Import":

<Image img="https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman6.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=5aeb544cb6e4aa206e259235fcf1d3ec" size="md" alt="Collection > Import" border data-og-width="666" width="666" data-og-height="253" height="253" data-path="images/cloud/manage/postman/postman6.webp" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman6.webp?w=280&fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=a4444e0c3ce8d64cde3e77e0b2563077 280w, https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman6.webp?w=560&fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=ba03723432e19d2e321faea706d00392 560w, https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman6.webp?w=840&fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=c79b13133b70b7f780f60628611d1dc1 840w, https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman6.webp?w=1100&fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=4a8d03af4463b1963d82f03665b025a9 1100w, https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman6.webp?w=1650&fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=62c56593e6ab60f29d99629c3a938868 1650w, https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman6.webp?w=2500&fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=bf96c32c57a46060627d6a1085742b8f 2500w" />

<div id="interface-with-the-clickhouse-cloud-api-spec">
  ### التعامل مع مواصفة واجهة برمجة تطبيقات ClickHouse Cloud
</div>

* ستظهر الآن "مواصفة واجهة برمجة تطبيقات ClickHouse Cloud" ضمن "Collections" (شريط التنقل الأيسر).

<Image img="https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman7.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=106b05bb49433c944fc7c2f599eceefc" size="md" alt="استيراد واجهة برمجة تطبيقاتك" border width="949" height="446" data-path="images/cloud/manage/postman/postman7.webp" />

* انقر على "مواصفة واجهة برمجة تطبيقات ClickHouse Cloud". ومن الجزء الأوسط، اختر علامة التبويب 'Authorization':

<Image img="https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman8.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=5bc05781c5b4efba03b70765b874ccfd" size="md" alt="اكتمل الاستيراد" border width="872" height="420" data-path="images/cloud/manage/postman/postman8.webp" />

<div id="set-authorization">
  ### إعداد التفويض
</div>

* استخدم القائمة المنسدلة لتحديد "Basic Auth":

<Image img="https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman9.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=44ec6fbe17b3f31cd4b6dc0671fe2ae9" size="md" alt="المصادقة الأساسية" border width="789" height="620" data-path="images/cloud/manage/postman/postman9.webp" />

* أدخل اسم المستخدم وكلمة المرور اللذين تلقيتهما عند إعداد مفاتيح واجهة برمجة تطبيقات ClickHouse Cloud:

<Image img="https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman10.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=4d4483bd24291db81680101b27085e8e" size="md" alt="بيانات الاعتماد" border width="951" height="700" data-path="images/cloud/manage/postman/postman10.webp" />

<div id="enable-variables">
  ### تفعيل المتغيرات
</div>

* تتيح [المتغيرات](https://learning.postman.com/docs/sending-requests/variables/) تخزين القيم وإعادة استخدامها في Postman، مما يسهّل اختبار واجهات برمجة التطبيقات.

<div id="set-the-organization-id-and-service-id">
  #### عيّن معرّف المؤسسة ومعرّف الخدمة
</div>

* ضمن "مجموعة"، انقر على علامة التبويب "Variable" في الجزء الأوسط (سيكون عنوان URL الأساسي قد تم تعيينه عبر استيراد واجهة برمجة التطبيقات السابق):
* أسفل `baseURL`، انقر على الحقل الفارغ "Add new value"، ثم أدخِل معرّف المؤسسة ومعرّف الخدمة:

<Image img="https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman11.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=91355d46e8fac8d57c0d617e657ec3a9" size="md" alt="معرّف المؤسسة ومعرّف الخدمة" border width="1057" height="558" data-path="images/cloud/manage/postman/postman11.webp" />

<div id="test-the-clickhouse-cloud-api-functionalities">
  ## اختبر وظائف واجهة برمجة تطبيقات ClickHouse Cloud
</div>

<div id="test-get-list-of-available-organizations">
  ### اختبر "GET list of available organizations"
</div>

* ضمن "OpenAPI spec for ClickHouse Cloud"، وسّع المجلد > V1 > organizations
* انقر على "GET list of available organizations" ثم اضغط الزر الأزرق "Send" على اليمين:

<Image img="https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman12.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=96ff4d7ea740cc25ce4fb31256e43f29" size="md" alt="اختبار استرجاع organizations" border width="1797" height="972" data-path="images/cloud/manage/postman/postman12.webp" />

* ينبغي أن تعرض النتائج المُعادة تفاصيل مؤسستك الخاصة بك مع "status": 200. (إذا تلقيت "status" 400 من دون أي معلومات عن مؤسسة، فهذا يعني أن الإعداد غير صحيح).

<Image img="https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman13.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=949424cb663899a2c913b1b5b621acf4" size="md" alt="الحالة" border width="1797" height="972" data-path="images/cloud/manage/postman/postman13.webp" />

<div id="test-get-organizational-details">
  ### اختبار "GET organizational details"
</div>

* ضمن المجلد `organizationid`، انتقل إلى "GET organizational details":
* في قائمة الإطار الأوسط ضمن Params، تكون قيمة `organizationid` مطلوبة.

<Image img="https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman14.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=358d1e8b53819a44ea9a5b35aedd3300" size="md" alt="اختبار استرجاع تفاصيل المؤسسة" border width="1797" height="972" data-path="images/cloud/manage/postman/postman14.webp" />

* عدّل هذه القيمة إلى `orgid` بين أقواس معقوفة `{{orgid}}` (بعد ضبط هذه القيمة مسبقًا، ستظهر قائمة تتضمن القيمة):

<Image img="https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman15.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=11b67ee3957f28aa2cd605bc4f13e951" size="md" alt="إرسال الاختبار" border width="1797" height="972" data-path="images/cloud/manage/postman/postman15.webp" />

* بعد الضغط على زر "Save"، اضغط على الزر الأزرق "Send" في أعلى يمين الشاشة.

<Image img="https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman16.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=97d42e302acf56c88ba8b5eaeb197659" size="md" alt="القيمة المُعادة" border width="1797" height="972" data-path="images/cloud/manage/postman/postman16.webp" />

* يجب أن تعرض النتائج المُعادة تفاصيل مؤسستك مع "status": 200. (إذا تلقيت "status" 400 من دون أي معلومات عن المؤسسة، فهذا يعني أن الإعداد غير صحيح).

<div id="test-get-service-details">
  ### اختبر "GET service details"
</div>

* انقر على "GET service details"
* عدّل القيم الخاصة بـ `organizationid` و`serviceid` باستخدام `{{orgid}}` و`{{serviceid}}` على التوالي.
* اضغط على "Save" ثم على الزر الأزرق "Send" الموجود على اليمين.

<Image img="https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman17.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=73c2790abde9d00ddfb5904c02c1aa53" size="md" alt="قائمة الخدمات" border width="1537" height="867" data-path="images/cloud/manage/postman/postman17.webp" />

* يجب أن تعرض النتائج المُعادة قائمة بخدماتك وتفاصيلها مع "status": 200. (إذا تلقيت "status" 400 من دون معلومات عن الخدمات، فهذا يعني أن إعدادك غير صحيح).
