محفوظة منذ أكتوبر 2019

واجهة برمجة التطبيقات العامة، ولماذا استغرقت سبع سنوات

أصدرت المنصة في الإصدار 5.4 واجهة API موثقة برمز مميز في يونيو. إليك ما تفعله، وما ترفض عمدًا فعله، ولماذا انتظرنا طويلاً.

غادرت الواجهة البرمجية (API) مرحلة البيتا في الثاني من يوليو. تم إصدارها ضمن المراجعة 5.4 للمنصة في يونيو، وعملت كبيتا دعوة من فبراير مع ما يزيد قليلاً عن أربعمائة حساب عليها، ولم يتغير شكلها منذ أبريل. مُصدّرة، وموثقة، ومغطاة بنفس التزام التوافر مثل اللوحة.

إن وصفها بالمتأخرة سيكون من باب المجاملة. السبب ليس غامضاً: واجهة موضوعة فوق نظام تزويد يحتاج إلى ثلاث دقائق ونصف لبناء خادم ستكون واجهة للاستعلام عن مؤشر دوران. أعدنا كتابة قائمة الانتظار أولاً، في عام 2025، وكان الترتيب مقصوداً وليس صدفة.

ما تقدمه

المجموعةما يمكنك فعلهملاحظات
الحالاتإنشاء، تغيير الحجم، إعادة بناء، لقطة، استعادة، تدميرتغيير الحجم تصاعدياً فوري، وتغيير الحجم تنازلياً يتطلب إعادة تشغيل واحدة
الصورسرد كتالوج أنظمة التشغيل، تسجيل ISO مخصص عبر URLتثبيتات ISO المخصصة لا تزال يدوية ولا تزال بطيئة
الشبكاتإضافة IPv4، تعديل DNS العكسي، طلب IPv6 /48مُفوَّض، وليس وسيطاً أبداً
التصفيةقراءة أحداث الهجمات، دفع قواعد الطبقة السابعة على DDoS Proالتصفية الأساسية لا تحتوي على شيء لتكوينه
الفوترةقراءة الرصيد، سرد الفواتير، فتح فاتورة تعبئة رصيدلا توجد حقول بطاقة، لأنه لا توجد بطاقات
الأحداثالاستعلام عن سجل الأحداث أو تسجيل خطاف ويب (webhook)موقَّعة بسر خاص بكل حساب

كل شيء JSON عبر HTTPS، وكل كائن يمكن للوحة عرضه هو كائن يمكن لواجهة API إرجاعه. لا توجد طبقة من الوظائف محجوزة لواجهة الويب، وهو وعد يكلفنا شيئاً: اللوحة الآن تستهلك نفس نقاط النهاية العامة التي تستهلكها، لذا فإن واجهة API مكسورة تعني لوحة مكسورة ونكتشف ذلك فوراً.

المصادقة

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

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

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

حدود المعدل، والتماثل، والأخطاء

ستمائة قراءة في الدقيقة وستون كتابة، تُحسب لكل رمز وليس لكل حساب، لذا لا يمكن لسيناريو واحد مزعج أن يجوع باقي أتمتتك. يتم إرجاع الحدود في الترويسات على كل استجابة، بما في ذلك الناجحة.

تقبل كل كتابة مفتاح تماثل. أعد المحاولة مع نفس المفتاح لإنشاء واستعد الحالة الأصلية بدلاً من حالة ثانية يتم فوترتها بجانبها. هذه هي الميزة الوحيدة التي شكرنا عليها معظم مختبري البيتا، وهذا يخبرك شيئاً عن كيفية تعامل بقية الصناعة مع مهلة زمنية أثناء التزويد.

الأخطاء هي رمز آلة موثق، وجملة واحدة يمكن للإنسان قراءتها، ومعرف طلب. الصق المعرف في تذكرة وسيتمكن الدعم من رؤية نفس الطلب الذي رأيته، دون أن يطلب منك إعادة إنتاجه.

ما لا يفعله عمداً

  • لا عملات ورقية، أبداً. تقرأ نقاط نهاية الفوترة رصيدك وتفتح فاتورة تعبئة رصيد. يظل التسوية مع OxaPay والسلسلة التي اخترتها، تماماً كما هو موضح في صفحة المدفوعات.
  • لا حسابات فرعية أو أدوار. مطلوب باستمرار. لم يُبن، لأن التنفيذ الواضح يعني الاحتفاظ بهيكل من يعمل لمن، ونفضل إصدار رموز بنطاقات تنتهي صلاحيتها وتترك مخطط مؤسستك لنفسك.
  • لا توسع تلقائي. الحالات هي أنوية مخصصة على سيليكون حقيقي، وليست تجمعاً يمكننا استحضاره منه. يمكنك الإنشاء والتدمير وفق جدولك الخاص؛ لن نتظاهر بوجود تجريد مرن تحتها.
  • لا مصفوفة حزم تطوير (SDK). عميل مرجعي واحد، وHTTP الصريح كعقد. ستكون ست روابط لغات نصف مصانة أسوأ من التوثيق.

ما نود كسره

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

المرجع موجود على التوثيق. يسرد سجل التغييرات للمراجعة 5.4 نقاط النهاية السبعة التي تغير شكلها بين فبراير ومارس وأبريل، وهذه هي التغييرات الكسرية الوحيدة التي ستحدث داخل الإصدار الأول.

جاهز عندما تكون

اختر مدينة. اختر الحجم. ادفع بالعملة الرقمية.

لا نماذج عن هويتك، ولا انتظار لموافقة بشرية، ولا مكالمة للتحقق من أي شيء. بمجرد تصفية الفاتورة، تصل بيانات الدخول إلى بريدك الإلكتروني.