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

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

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

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

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

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

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

كوّن مفتاح واجهة برمجة تطبيقات

حدّد اسم المفتاح وأذوناته ووقت انتهاء صلاحيته.

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

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

أضف عناوين IP المسموح بها

لتقييد العملاء الذين يمكنهم استخدام مفتاح واجهة برمجة تطبيقات، انتقل إلى قسم Allow access to this API Key وحدّد Specific locations. أدخل عنوان IP أو نطاق CIDR، مثل 203.0.113.1 أو 203.0.113.0/24، ثم أضف إدخالات أخرى حسب الحاجة.تلتزم Query API Endpoints بقوائم السماح لعناوين IP على مستوى مفتاح واجهة برمجة تطبيقات. ونظرًا لأن الطلبات تُمرَّر عبر وكيل من داخل بنية ClickHouse التحتية، فلا تنطبق قوائم السماح لعناوين IP على مستوى الخدمة. راجع IP Access Control لمزيد من التفاصيل.انقر على Generate API Key عند الانتهاء من تكوين المفتاح.

احفظ بيانات اعتماد مفتاح واجهة برمجة تطبيقات

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

صادِق طلبات واجهة برمجة تطبيقات

تستخدم واجهة برمجة تطبيقات 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

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

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

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

نقاط النهاية

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

​نقاط النهاية

نقاط النهاية