إدارة مفاتيح واجهة برمجة تطبيقات

يوفّر ClickHouse Cloud واجهة برمجة تطبيقات تستند إلى OpenAPI تتيح لك إدارة حسابك وبعض جوانب خدماتك برمجيًا.

يوفّر ClickHouse Cloud واجهة برمجة تطبيقات تستند إلى OpenAPI، وتتيح لك إدارة حسابك وبعض جوانب خدماتك برمجيًا.

يغطي هذا المستند واجهة برمجة تطبيقات ClickHouse Cloud. للاطلاع على نقاط نهاية واجهة برمجة تطبيقات قاعدة البيانات، يُرجى مراجعة Cloud Endpoints API

1. يمكنك استخدام علامة التبويب مفاتيح واجهة برمجة تطبيقات في القائمة اليمنى لإنشاء مفاتيح واجهة برمجة التطبيقات الخاصة بك وإدارتها.

2. ستعرض صفحة مفاتيح واجهة برمجة تطبيقات في البداية رسالةً تطلب منك إنشاء أول مفتاح واجهة برمجة تطبيقات، كما هو موضح أدناه. بعد إنشاء مفتاحك الأول، يمكنك إنشاء مفاتيح جديدة باستخدام زر New API Key الذي يظهر في الزاوية العلوية اليمنى.

3. لإنشاء مفتاح واجهة برمجة تطبيقات، حدِّد اسم المفتاح وأذونات المفتاح ووقت انتهاء الصلاحية، ثم انقر على Generate API Key.

تتوافق الأذونات مع الأدوار المحددة مسبقًا في ClickHouse Cloud. يمتلك دور المطوّر أذونات قراءة فقط للخدمات المعيّنة، بينما يمتلك دور المسؤول أذونات كاملة للقراءة والكتابة.

Query API Endpoints

لاستخدام مفاتيح واجهة برمجة تطبيقات مع Query API Endpoints، اضبط Organization Role على Member (كحد أدنى)، وامنح Service Role إمكانية الوصول إلى Query Endpoints.

4. ستعرض الشاشة التالية معرّف المفتاح وسرّ المفتاح. انسخ هاتين القيمتين واحفظهما في مكان آمن، مثل خزنة. لن تُعرض هذه القيم بعد مغادرة هذه الشاشة.

5. تستخدم واجهة برمجة تطبيقات ClickHouse Cloud HTTP Basic Authentication للتحقق من صحة مفاتيح واجهة برمجة تطبيقات الخاصة بك. إليك مثالًا على كيفية استخدام مفاتيح واجهة برمجة تطبيقات لإرسال طلبات إلى واجهة برمجة تطبيقات ClickHouse Cloud باستخدام curl:

$ KEY_ID=mykeyid
$ KEY_SECRET=mykeysecret

$ curl --user $KEY_ID:$KEY_SECRET https://api.clickhouse.cloud/v1/organizations

6. بالعودة إلى صفحة مفاتيح واجهة برمجة تطبيقات، سترى اسم المفتاح، وآخر أربعة أحرف من معرّف المفتاح، والأذونات، والحالة، وتاريخ انتهاء الصلاحية، والمنشئ. يمكنك من هذه الشاشة تعديل اسم المفتاح، والأذونات، وتاريخ انتهاء الصلاحية. كما يمكنك أيضًا من هذه الشاشة تعطيل المفاتيح أو حذفها.

حذف مفتاح واجهة برمجة تطبيقات إجراء دائم. وستفقد أي خدمات تستخدم هذا المفتاح إمكانية الوصول إلى ClickHouse Cloud فورًا.

​

نقاط النهاية

للاطّلاع على تفاصيل نقاط النهاية، راجِع مرجع واجهة برمجة التطبيقات. استخدم مفتاح واجهة برمجة التطبيقات والسرّ الخاص بها مع عنوان URL الأساسي https://api.clickhouse.cloud/v1.