> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-detect-table-modification.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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman1.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=e72b02c9a09b332543342a976050a598" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman2.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=422dc9b811724600a51e1d1a06d6715a" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman3.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=a7d14257917557203e22bada43717d21" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman3.webp?w=280&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=ac2f100cbe86e984d3b66a308146f0cd 280w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman3.webp?w=560&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=542f48107296f4485736c59604593208 560w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman3.webp?w=840&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=ed138923ff712a2e09492ed31ef9edf9 840w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman3.webp?w=1100&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=f1efa5f6abd08c2e14d38cda0d4e36dc 1100w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman3.webp?w=1650&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=4b72f67d2ac0bbb25f071a3b73dbf534 1650w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman3.webp?w=2500&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=ea1bce2f113aa7d3ab29fe0c78b8e353 2500w" />

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

<Image img="https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman4.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=38d7979ba98296590d9c876c7d6bbccb" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman6.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=6bd414437c263a49d05d55300aa41607" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman6.webp?w=280&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=5149e81347497a0df7d06f060b99b822 280w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman6.webp?w=560&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=7ba9aa5b66c74bee6730f21bee456316 560w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman6.webp?w=840&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=de244832ed3f24daadd81afad9bac75e 840w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman6.webp?w=1100&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=72fa09b007806eca09e1da831735efde 1100w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman6.webp?w=1650&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=6b85cbf014b4428de85fcc4f48d2f5e6 1650w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman6.webp?w=2500&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=ba79eab2e06318ccd050a81e94b9fe7e 2500w" />

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

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

<Image img="https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman7.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=f432316604acb31ef159bd741f2da343" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman8.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=c2b4bef760535aaaf9e07c87f6e82bbf" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman9.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=46e01ea2fabaf65a6da25e766da0df9e" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman10.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=eaef923ed7870f4961a1eabbd833b847" 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>

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

<Image img="https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman11.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=1e0c8d519c256c952ee61ec294cc35b6" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman12.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=99392d42cebe9764355dfae7651ece65" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman13.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=ad80488a9cf6ba5ba56d515f1eeb3a1e" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman14.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=58f20cc3221acecc731381238beef8f5" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman15.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=d7e951fe258b988a3c81a6d8dd9c8e0e" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman16.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=b9a490e9416289f5f465372cfeb910f7" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman17.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=a5f2ad863c44e1871bcb6ae45689304a" size="md" alt="قائمة الخدمات" border width="1537" height="867" data-path="images/cloud/manage/postman/postman17.webp" />

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