> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4.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}) => {
  return <Frame>
      <img src={img} alt={alt} />
    </Frame>;
};

سيساعدك هذا الدليل في اختبار واجهة برمجة تطبيقات 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-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman1.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=8dec2b8e732c3532bd706b749cb3ddbe" size="md" alt="موقع Postman" border width="1621" height="1011" data-path="images/cloud/manage/postman/postman1.png" />

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

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

<Image img="https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman2.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=8484a44c3a859c2176253eafe4916352" size="md" alt="إنشاء مساحة عمل" border width="784" height="760" data-path="images/cloud/manage/postman/postman2.png" />

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

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

<Image img="https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman3.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=6d4aed425d88aeb47fc8d4894863059a" 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.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman3.png?w=280&fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=602c6d10ea86d56aea686e721c17fc4e 280w, https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman3.png?w=560&fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=eeffd780f3cc6b3eb09140e7e0c7ddec 560w, https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman3.png?w=840&fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=52edc70a3e65fb246703dd75d232c788 840w, https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman3.png?w=1100&fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=071f8ca68d7a09c4ac3fd61eef5bd032 1100w, https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman3.png?w=1650&fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=ecc2e84bae99f8eb59bd13b9e09593ac 1650w, https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman3.png?w=2500&fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=26fca1607f60af3ebc3f1fd7c3cbd883 2500w" />

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

<Image img="https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman4.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=8785f5772f2ff830355d737e5446f281" size="md" alt="إدخال عنوان URL لواجهة برمجة التطبيقات" border width="659" height="471" data-path="images/cloud/manage/postman/postman4.png" />

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

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

<Image img="https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman6.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=8924a98ef43b89e2e80da2d48af5b2d6" 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.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman6.png?w=280&fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=60a923c818e14533915ba570ff51dc83 280w, https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman6.png?w=560&fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=1f379bf19421ef4862029ae8c1e180f9 560w, https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman6.png?w=840&fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=272ae8b84cd4c88ebff4f8d2a54fea29 840w, https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman6.png?w=1100&fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=e372d4731887d7d4103a69cc9c950d56 1100w, https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman6.png?w=1650&fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=1b62929be42a4446b8f5b272be518c82 1650w, https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman6.png?w=2500&fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=4ed0853d18ab7f0f17cadaefd7d9d849 2500w" />

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

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

<Image img="https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman7.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=48bb0f7f5fd4e21064927373e9e3da85" size="md" alt="استيراد واجهة برمجة تطبيقاتك" border width="949" height="446" data-path="images/cloud/manage/postman/postman7.png" />

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

<Image img="https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman8.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=27c04859b178b085ce1619cf260ef9e9" size="md" alt="اكتمل الاستيراد" border width="872" height="420" data-path="images/cloud/manage/postman/postman8.png" />

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

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

<Image img="https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman9.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=3c42e489c506c27faf88ede27843e71d" size="md" alt="المصادقة الأساسية" border width="789" height="620" data-path="images/cloud/manage/postman/postman9.png" />

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

<Image img="https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman10.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=fed6667e2d0ff7e44ccf057afdb744b6" size="md" alt="بيانات الاعتماد" border width="951" height="700" data-path="images/cloud/manage/postman/postman10.png" />

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

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

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

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

<Image img="https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman11.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=87bbac8941b2b5ed35af2227e1e886fc" size="md" alt="معرّف المؤسسة ومعرّف الخدمة" border width="1057" height="558" data-path="images/cloud/manage/postman/postman11.png" />

<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-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman12.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=b4755500eccddc9665f0ba21b8bb8fe0" size="md" alt="اختبار استرجاع organizations" border width="1797" height="972" data-path="images/cloud/manage/postman/postman12.png" />

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

<Image img="https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman13.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=e5af7e52ccfaceb93f4e6d92057f9047" size="md" alt="الحالة" border width="1797" height="972" data-path="images/cloud/manage/postman/postman13.png" />

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

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

<Image img="https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman14.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=823a77e43e32de30c966862207b1835d" size="md" alt="اختبار استرجاع تفاصيل المؤسسة" border width="1797" height="972" data-path="images/cloud/manage/postman/postman14.png" />

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

<Image img="https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman15.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=2382d6d9a023ef1c42333029fa3b0471" size="md" alt="إرسال الاختبار" border width="1797" height="972" data-path="images/cloud/manage/postman/postman15.png" />

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

<Image img="https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman16.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=32f564164d26e68e4f7f1db8050fe419" size="md" alt="القيمة المُعادة" border width="1797" height="972" data-path="images/cloud/manage/postman/postman16.png" />

* يجب أن تعرض النتائج المُعادة تفاصيل مؤسستك مع "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-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman17.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=071cd7570925074fe54d8dd07a521a72" size="md" alt="قائمة الخدمات" border width="1537" height="867" data-path="images/cloud/manage/postman/postman17.png" />

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