PmaControl — المطورون وواجهة API
بداية سريعة
استعلم عن الموارد العامة أدناه باستخدام curl. لا تتطلب واجهة القراءة فقط حسابًا أو نموذج مبيعات أو مفتاح API. تستخدم الردود تنسيق JSON.
curl -sS https://www.pmacontrol.com/api/v1/capabilities
curl -sS 'https://www.pmacontrol.com/api/v1/documentation?language=en'
curl -sS https://www.pmacontrol.com/api/v1/permissions
المصادقة والصلاحيات
تظل موارد الاكتشاف وبيئة الاختبار العامة متاحة دون بيانات اعتماد. لاختبار تكامل موثق، سجل عميل OAuth سريًا بنفسك عبر /oauth/register ثم اطلب رمز client_credentials من /oauth/token. النطاقان sandbox.servers.read وsandbox.identity.read معلنان في OpenAPI ويجري فرضهما على المسارات المحمية. تنتهي صلاحية سر العميل بعد 24 ساعة والرمز خلال 600 ثانية كحد أقصى. لا تتيح هذه البيانات الوصول إلى تثبيتات العملاء التي تبقى إدارتها منفصلة.
العقد والأخطاء
يصف عقد OpenAPI العمليات والمعاملات والردود. تستخدم الأخطاء application/problem+json. الحد العام هو 300 طلب لكل عنوان IP خلال 60 ثانية. يوضح RateLimit-Policy وRateLimit السياسة والحصة المتبقية والثواني حتى التجديد، مع توفير RateLimit-Limit وRateLimit-Remaining وRateLimit-Reset للتوافق. بعد HTTP 429 انتظر عدد الثواني في Retry-After. تتبع الحقول مسودة IETF httpapi-ratelimit-headers-11 ولا يوجد ضمان للتوفر.
بيئة اختبار مجانية
اختبر ردًا اصطناعيًا لـ MariaDB / MySQL دون حساب أو مفتاح. المقاييس أمثلة ثابتة ولا تتصل بقواعد بيانات العملاء. البيئة للقراءة فقط ولا تحاكي صلاحيات الإنتاج. تتطلب تجربة Pro الحالية تأكيد البريد ومعرف UUID للتثبيت؛ والترخيص ليس مفتاح API.
curl -sS https://www.pmacontrol.com/api/v1/sandbox/servers
أداة CLI الرسمية من PmaControl
ثبت الأداة من مستودع Homebrew الرسمي على macOS أو Linux. تستخدم الصيغة Python 3.13 وتتحقق من SHA-256 لأرشيف المصدر المنشور. تعيد أوامر capabilities وpermissions وschema وdocs وsandbox بيانات JSON دون حساب أو مفتاح. تتوفر الحزمة ومصدرها علنًا على هذا الموقع.
brew tap pmacontrol/agent https://www.pmacontrol.com/downloads/homebrew-agent.git
brew install pmacontrol/agent/pmacontrol-agent
pmacontrol-agent --version
pmacontrol-agent capabilities
pmacontrol-agent docs --language fr
pmacontrol-agent sandbox
بيانات اعتماد بيئة الاختبار بالخدمة الذاتية
ينشئ المسار التالي معرف عميل وسرًا دون حساب أو دفع، ثم رمزًا يقتصر على sandbox.servers.read. استبدل CLIENT_ID وCLIENT_SECRET وACCESS_TOKEN بالقيم المعادة. لاختبار هوية العميل اطلب sandbox.identity.read صراحة. يقتصر التسجيل على خمسة عملاء في الساعة لكل IP و120 عميلًا في الساعة للخدمة، وتقبل نقطة الرموز 30 طلبًا في الدقيقة لكل IP. تكون حقول الحصة الحالية وRetry-After هي المرجع.
curl -sS https://www.pmacontrol.com/oauth/register \
-H 'Content-Type: application/json' \
--data '{"grant_types":["client_credentials"],"response_types":[],"scope":"sandbox.servers.read"}'
curl -sS https://www.pmacontrol.com/oauth/token \
--user 'CLIENT_ID:CLIENT_SECRET' \
--data 'grant_type=client_credentials&scope=sandbox.servers.read'
curl -sS https://www.pmacontrol.com/api/v1/sandbox/authorized-servers \
-H 'Authorization: Bearer ACCESS_TOKEN'
إصدارات الواجهة وإيقاف الدعم
واجهة REST v1 نشطة وإصدار العقد الحالي 1.1.0. تستخدم الإضافات المتوافقة إصدارًا فرعيًا، وتتطلب التغييرات غير المتوافقة عنوان إصدار رئيسي جديد مثل /api/v2. لا يوجد موعد لإيقاف v1. قبل الإيقاف ننشر إشعارًا مؤرخًا ودليل انتقال قبل 90 يومًا على الأقل، باستثناء طوارئ أمنية أو التزامات قانونية موثقة.
عند إيقاف دعم مورد، يحمل Deprecation تاريخًا منظمًا وفق RFC 9745 بصيغة @Unix_seconds، ويحمل Sunset تاريخ HTTP للإيقاف بتوقيت GMT وفق RFC 8594. لا يسبق Sunset تاريخ Deprecation أبدًا. يقود رابط HTTP ذي rel=deprecation إلى هذه السياسة وتعليمات الانتقال. تعرض الموارد النشطة الرابط دون إعلان تاريخ إيقاف وهمي.
سياسة الواجهة القابلة للقراءة آليًا