> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-55d9d317.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-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman1.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=f53a2779dc9e83f8250e97426b9d59cc" 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-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman2.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=977b7c52759645a67f1d8b83fa08d22e" 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-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman3.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=d8f3df9c9cc793605af6c55dc4b65636" 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-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman3.png?w=280&fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=e8d7887e30d038eaaf36a43000db69aa 280w, https://mintcdn.com/private-7c7dfe99-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman3.png?w=560&fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=693e9d292cdc6e12f8d938f0f7050f9a 560w, https://mintcdn.com/private-7c7dfe99-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman3.png?w=840&fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=2d4f5063345589279ce21b6cb0c378b0 840w, https://mintcdn.com/private-7c7dfe99-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman3.png?w=1100&fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=ed549d6637a30e2aee0d25257ca322a8 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman3.png?w=1650&fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=fa364c0bf3e008f8abf0ab4af5e3c295 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman3.png?w=2500&fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=d1c886a84679d7c33ef59a5d9a520f0e 2500w" />

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

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman4.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=cc19090779583f81661a7d8f9a810fea" 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-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman6.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=53b73c4393c2cd377d79aa095dc18b57" 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-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman6.png?w=280&fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=57fc2dea63566ade7f35daa353cff6e0 280w, https://mintcdn.com/private-7c7dfe99-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman6.png?w=560&fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=c24384a96b2fef48a84f53bee9f2bc70 560w, https://mintcdn.com/private-7c7dfe99-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman6.png?w=840&fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=b1f5d02f802bf8c5aa34dfaf6df1ee66 840w, https://mintcdn.com/private-7c7dfe99-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman6.png?w=1100&fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=3c9c3ac415919b049af4e22360391648 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman6.png?w=1650&fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=5f2347fe6eefe582763c61a3aaaaaaa6 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman6.png?w=2500&fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=6c9662295ac496af00ade257b02c7f62 2500w" />

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

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

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman7.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=e41bcb0056f3b327224b262c7a0c9527" 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-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman8.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=d1c39911a167434f63a3f8ce7d4876f3" 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-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman9.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=78c0753393c1d08da1074c694d69b257" 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-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman10.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=a0121ff2e764a7dafdc9d2ec7f7603b7" 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-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman11.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=3e88a45897fa4fe0335b5d4166507a87" 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-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman12.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=1016682b22b9f744825fefceef436319" 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-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman13.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=9a6366dea1c2fb515cd4e98e19781ec2" 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-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman14.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=7a3647286a741cf48c43ea364da99051" 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-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman15.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=8b406c77099ec3528f04a4ad90ac419c" 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-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman16.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=acfd69542be767fef0993d87dfe66743" 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-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman17.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=04bd7250960e7f3e0d895f982c013914" size="md" alt="قائمة الخدمات" border width="1537" height="867" data-path="images/cloud/manage/postman/postman17.png" />

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