> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-a804b3ad.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-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman1.png?fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=cebc7a629e4e3f8190e60ef56566bbfd" 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-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman2.png?fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=eea5442c0b04542d4d705c585992b0e3" 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-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman3.png?fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=e579ae9eee204608468db336e96f6997" 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-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman3.png?w=280&fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=6b79e24527d9389816bbf3ecf88eeb92 280w, https://mintcdn.com/private-7c7dfe99-mintlify-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman3.png?w=560&fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=48571c0230c85ad86e0205c2f6708dd4 560w, https://mintcdn.com/private-7c7dfe99-mintlify-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman3.png?w=840&fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=76bdf2399545c8d9001be3193bf5eb71 840w, https://mintcdn.com/private-7c7dfe99-mintlify-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman3.png?w=1100&fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=3e74163d54e6baf8cfabdf227d4c1895 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman3.png?w=1650&fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=2c5e94f75a65bbd81ddfe0cba821072c 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman3.png?w=2500&fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=4fbb95d959acb31feb6a83608d4162eb 2500w" />

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

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman4.png?fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=4a42797a9e972c2fb462141b4becf4b8" 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-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman6.png?fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=284de5828f673e4c1c9728e6b7c848c4" 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-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman6.png?w=280&fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=eec6262a41ab6007507e4c07e66d9855 280w, https://mintcdn.com/private-7c7dfe99-mintlify-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman6.png?w=560&fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=267905365aa96ad14a3ab2932ff59e77 560w, https://mintcdn.com/private-7c7dfe99-mintlify-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman6.png?w=840&fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=5cba1147f359d85497ec4dc920dbba3d 840w, https://mintcdn.com/private-7c7dfe99-mintlify-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman6.png?w=1100&fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=e7528e57c708aebb96866afc6fba5907 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman6.png?w=1650&fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=7cdd7ade637727b607002c25cda46146 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman6.png?w=2500&fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=42b2390a7f0354e342d5d70a90b7b32e 2500w" />

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

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

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman7.png?fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=368ccdbccabcd94a7e92f9a3194168f6" 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-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman8.png?fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=908913e4cc5f91c97bda842d341efb9c" 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-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman9.png?fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=aa7ab3549665043384013da40d3fedd2" 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-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman10.png?fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=1f6b2cb5c464cdb0189e199f9cf99a82" 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-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman11.png?fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=6bbe23247544fcf53c82f6c4bb3639ae" 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-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman12.png?fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=73bb51cd49f22c6c38953d24866fdc3f" 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-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman13.png?fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=5bffd2af6f8f8f4462a72f2b9b449d52" 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-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman14.png?fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=d69fea847f33a3421a83050f126e2103" 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-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman15.png?fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=f88baa7bf3e84efd6437cb19b5043299" 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-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman16.png?fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=f419ac1903e9ec4cef40b98ccf95553b" 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-a804b3ad/CKN3ZBo9p0pw2LrE/images/cloud/manage/postman/postman17.png?fit=max&auto=format&n=CKN3ZBo9p0pw2LrE&q=85&s=d3bf719d80f4ad098ea1308e43a6a42c" size="md" alt="قائمة الخدمات" border width="1537" height="867" data-path="images/cloud/manage/postman/postman17.png" />

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