> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-9c5a0d9c.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-mintlify-9c5a0d9c/bqve6XwWQTB657YN/images/cloud/manage/postman/postman1.png?fit=max&auto=format&n=bqve6XwWQTB657YN&q=85&s=713a7eaa706785e460964b8b8c3da053" 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-mintlify-9c5a0d9c/bqve6XwWQTB657YN/images/cloud/manage/postman/postman2.png?fit=max&auto=format&n=bqve6XwWQTB657YN&q=85&s=dffb69307bc4322763c5baffdc902ea0" 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-mintlify-9c5a0d9c/bqve6XwWQTB657YN/images/cloud/manage/postman/postman3.png?fit=max&auto=format&n=bqve6XwWQTB657YN&q=85&s=6d1284fbfeaf61501a4f95fbee0868bb" 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-mintlify-9c5a0d9c/bqve6XwWQTB657YN/images/cloud/manage/postman/postman3.png?w=280&fit=max&auto=format&n=bqve6XwWQTB657YN&q=85&s=8476d0cf836e5414d64b5c3f5fd448c8 280w, https://mintcdn.com/private-7c7dfe99-mintlify-9c5a0d9c/bqve6XwWQTB657YN/images/cloud/manage/postman/postman3.png?w=560&fit=max&auto=format&n=bqve6XwWQTB657YN&q=85&s=91a7125d24a76cdf9920b41f02ac7d96 560w, https://mintcdn.com/private-7c7dfe99-mintlify-9c5a0d9c/bqve6XwWQTB657YN/images/cloud/manage/postman/postman3.png?w=840&fit=max&auto=format&n=bqve6XwWQTB657YN&q=85&s=6ce1a537c1e6b0d3384c4e51fa02a72c 840w, https://mintcdn.com/private-7c7dfe99-mintlify-9c5a0d9c/bqve6XwWQTB657YN/images/cloud/manage/postman/postman3.png?w=1100&fit=max&auto=format&n=bqve6XwWQTB657YN&q=85&s=2dca4566c94ff5eb5ad7446de5206a69 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-9c5a0d9c/bqve6XwWQTB657YN/images/cloud/manage/postman/postman3.png?w=1650&fit=max&auto=format&n=bqve6XwWQTB657YN&q=85&s=07d84f3989147a906fd646c15dfd02b9 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-9c5a0d9c/bqve6XwWQTB657YN/images/cloud/manage/postman/postman3.png?w=2500&fit=max&auto=format&n=bqve6XwWQTB657YN&q=85&s=fe18082ee199b54a4cb8de2a16e3e5c5 2500w" />

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

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-9c5a0d9c/bqve6XwWQTB657YN/images/cloud/manage/postman/postman4.png?fit=max&auto=format&n=bqve6XwWQTB657YN&q=85&s=f5c9b907c5d30d0c70577b629f64ed2d" 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-mintlify-9c5a0d9c/bqve6XwWQTB657YN/images/cloud/manage/postman/postman6.png?fit=max&auto=format&n=bqve6XwWQTB657YN&q=85&s=21306e1a6fc4e94933313d0dd3472198" 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-mintlify-9c5a0d9c/bqve6XwWQTB657YN/images/cloud/manage/postman/postman6.png?w=280&fit=max&auto=format&n=bqve6XwWQTB657YN&q=85&s=703a6ad71ade962f1ec05d4b284e4d80 280w, https://mintcdn.com/private-7c7dfe99-mintlify-9c5a0d9c/bqve6XwWQTB657YN/images/cloud/manage/postman/postman6.png?w=560&fit=max&auto=format&n=bqve6XwWQTB657YN&q=85&s=a47b8d2e13088a13cc48c307f8f0d374 560w, https://mintcdn.com/private-7c7dfe99-mintlify-9c5a0d9c/bqve6XwWQTB657YN/images/cloud/manage/postman/postman6.png?w=840&fit=max&auto=format&n=bqve6XwWQTB657YN&q=85&s=8f7be502eeb4629ed3158e4c52dc1de0 840w, https://mintcdn.com/private-7c7dfe99-mintlify-9c5a0d9c/bqve6XwWQTB657YN/images/cloud/manage/postman/postman6.png?w=1100&fit=max&auto=format&n=bqve6XwWQTB657YN&q=85&s=731843e8e4cdd74e60ccb2f90bff36b5 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-9c5a0d9c/bqve6XwWQTB657YN/images/cloud/manage/postman/postman6.png?w=1650&fit=max&auto=format&n=bqve6XwWQTB657YN&q=85&s=3c909707b4f0257660dddada5b43e8d1 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-9c5a0d9c/bqve6XwWQTB657YN/images/cloud/manage/postman/postman6.png?w=2500&fit=max&auto=format&n=bqve6XwWQTB657YN&q=85&s=aa2817586e3055460fab95d18f7839a0 2500w" />

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

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

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-9c5a0d9c/bqve6XwWQTB657YN/images/cloud/manage/postman/postman7.png?fit=max&auto=format&n=bqve6XwWQTB657YN&q=85&s=87657e765c9196c6092392b0248f682e" 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-mintlify-9c5a0d9c/bqve6XwWQTB657YN/images/cloud/manage/postman/postman8.png?fit=max&auto=format&n=bqve6XwWQTB657YN&q=85&s=dcef9d313ed92d42b75c4de57a6efbf2" 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-mintlify-9c5a0d9c/bqve6XwWQTB657YN/images/cloud/manage/postman/postman9.png?fit=max&auto=format&n=bqve6XwWQTB657YN&q=85&s=f480b82578dffe1a642f497fd8a7e672" 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-mintlify-9c5a0d9c/bqve6XwWQTB657YN/images/cloud/manage/postman/postman10.png?fit=max&auto=format&n=bqve6XwWQTB657YN&q=85&s=d1c3bef3115e3a0a5aeef0effb3d2137" 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-mintlify-9c5a0d9c/bqve6XwWQTB657YN/images/cloud/manage/postman/postman11.png?fit=max&auto=format&n=bqve6XwWQTB657YN&q=85&s=6f3385209d5f4c8b9e65c3596c78ce50" 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-mintlify-9c5a0d9c/bqve6XwWQTB657YN/images/cloud/manage/postman/postman12.png?fit=max&auto=format&n=bqve6XwWQTB657YN&q=85&s=16a60ea0975f0c8ddfc9bc7e5de14188" 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-mintlify-9c5a0d9c/bqve6XwWQTB657YN/images/cloud/manage/postman/postman13.png?fit=max&auto=format&n=bqve6XwWQTB657YN&q=85&s=2e0e91af8a03af1c9a9b8263f753088d" 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-mintlify-9c5a0d9c/bqve6XwWQTB657YN/images/cloud/manage/postman/postman14.png?fit=max&auto=format&n=bqve6XwWQTB657YN&q=85&s=68bc7a6342901202f44b0e893201e4b4" 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-mintlify-9c5a0d9c/bqve6XwWQTB657YN/images/cloud/manage/postman/postman15.png?fit=max&auto=format&n=bqve6XwWQTB657YN&q=85&s=70788dc0cf9ff1ed69110352e341c736" 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-mintlify-9c5a0d9c/bqve6XwWQTB657YN/images/cloud/manage/postman/postman16.png?fit=max&auto=format&n=bqve6XwWQTB657YN&q=85&s=182fa3df526e1600855a704841c71e8d" 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-mintlify-9c5a0d9c/bqve6XwWQTB657YN/images/cloud/manage/postman/postman17.png?fit=max&auto=format&n=bqve6XwWQTB657YN&q=85&s=f1c1f6aa2ab20c11e1a6df23be30e5b7" size="md" alt="قائمة الخدمات" border width="1537" height="867" data-path="images/cloud/manage/postman/postman17.png" />

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