التوثيق

مرجع API

الاستعلام عن أدوات قابلة للتنفيذ

GET/v1/tools

دعم موحّد لتسعير flat الثابت لكل استدعاء، وتسعير input المحسوب مسبقًا من المدخلات، وتسعير usage المبني على الاستخدام النهائي. يحدد pricing.quote_required إلزامية عرض السعر؛ ويحدد requires_usage الحاجة إلى سقف تكلفة واستخدام نهائي موثوق. لا يُستنتج أي منهما من schema_version. عند تعطيل metered_pricing، تُقيّد الاستدعاءات الجديدة التي تتطلب الاستخدام النهائي فقط؛ وتظل القواعد الثابتة/المبنية على المدخلات متاحة إن لم تحتج إلى استخدام نهائي. يجب أن يملك المفتاح الحالي صلاحية الأداة؛ وترتبط هوية التشغيل ونتائجه بالمفتاح الأصلي. يكون الدليل فارغًا عند تعطيل المفتاح الرئيسي للأدوات؛ ولا يمنح الدليل المجهول صلاحية التنفيذ.

المصادقة والصلاحيات

استخدم مفتاح GloopAPI الحالي. تعتمد النماذج والإمكانات والصلاحيات المتاحة على دليله ووثائق نقطة النهاية.

Authorization: Bearer $GLOOP_API_KEY

آليات المصادقة: BearerAuth

الطلب

معاملات الاستعلام

  • cursorstringاختياري

    next_cursor من الاستجابة الأصلية.

  • limitintegerاختياري

    نطاق الدليل 1–100، وتُستخدم 20 عند القيم غير الصالحة؛ ونطاق قائمة التشغيلات 1–100، وتُستخدم 20 عند القيم غير الصالحة.

الاستجابات والأخطاء

HTTP 200

تم الاستعلام عن الأدوات القابلة للتنفيذ بنجاح

application/json

النوع
object
الحقول المطلوبة
itemsnext_cursor
  • itemsarrayمطلوب
    الحقول الفرعية لـ items (1)
    • []objectاختياري
      الحقول الفرعية لـ [] (8)
      • category_idstringمطلوب

        معرّف فئة الأداة.

      • collection_idstringمطلوب

        معرّف مجموعة الأدوات.

      • tagsarrayمطلوب

        وسوم بحث عامة.

        الحقول الفرعية لـ tags (1)
        • []stringاختياري
      • idstringمطلوب

        المعرّف العام لهذا الكائن، المستخدم لمسار تفاصيله المقابل.

      • namestringمطلوب

        اسم مقروء للمستخدم.

      • descriptionstringمطلوب

        وصف الاستخدام العام.

      • versionstringمطلوب

        إصدار العقد/الإمكانات أو الأداة؛ تستخدم التشغيلات إصدار الأداة الذي يعيده الدليل.

      • pricingobjectمطلوب

        السعر العام؛ تسري عروض الأسعار وقواعد الفوترة الحالية.

        الحقول الفرعية لـ pricing (9)
        • schema_versionintegerاختياري

          إصدار قاعدة تسعير الأداة.

        • ruleunknownاختياري

          قيمة JSON يحددها مخطط الأداة المختارة أو البروتوكول؛ لا تفترض حقولًا ثابتة.

        • quote_requiredbooleanمطلوب

          هل يجب تأكيد عرض سعر قبل التشغيلات الجديدة.

        • currencystringمطلوب

          عملة عرض السعر/الفوترة.

        • unitstringمطلوب

          call لكل استدعاء أو حساب مسبق حسب المدخلات؛ usage حسب الاستخدام النهائي. راجع mode للمعنى الدقيق.

        • amountstringاختياري

          عند mode=flat يكون المبلغ الثابت الكامل بالدولار بما فيه الصفر؛ لا توفر input/usage مبلغًا ثابتًا مضللًا.

        • price_versionintegerمطلوب

          مراجعة سعر البيع.

        • modestringمطلوب

          دلالات سعر البيع: flat ثابت لكل استدعاء، وinput محسوب مسبقًا من المدخلات، وusage مبني على الاستخدام النهائي. مستقلة عن تنسيق بيانات schema_version.

          القيم المعدودة
          ["flat","input","usage"]
        • requires_usagebooleanمطلوب

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

        فرع allOf رقم 1

        النوع: object

        المطلوب في هذا الفرع: currency, unit, price_version, mode, quote_required, requires_usage

        • schema_versionintegerاختياري

          إصدار قاعدة تسعير الأداة.

        • ruleunknownاختياري

          قيمة JSON يحددها مخطط الأداة المختارة أو البروتوكول؛ لا تفترض حقولًا ثابتة.

        • quote_requiredbooleanمطلوب

          هل يجب تأكيد عرض سعر قبل التشغيلات الجديدة.

        • currencystringمطلوب

          عملة عرض السعر/الفوترة.

        • unitstringمطلوب

          call لكل استدعاء أو حساب مسبق حسب المدخلات؛ usage حسب الاستخدام النهائي. راجع mode للمعنى الدقيق.

        • amountstringاختياري

          عند mode=flat يكون المبلغ الثابت الكامل بالدولار بما فيه الصفر؛ لا توفر input/usage مبلغًا ثابتًا مضللًا.

        • price_versionintegerمطلوب

          مراجعة سعر البيع.

        • modestringمطلوب

          دلالات سعر البيع: flat ثابت لكل استدعاء، وinput محسوب مسبقًا من المدخلات، وusage مبني على الاستخدام النهائي. مستقلة عن تنسيق بيانات schema_version.

          القيم المعدودة
          ["flat","input","usage"]
        • requires_usagebooleanمطلوب

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

  • next_cursorstringمطلوب

HTTP 400

حقول الطلب أو معاملاته غير صالحة.

application/json

النوع
object
الحقول المطلوبة
error
  • errorobjectمطلوب
    الحقول الفرعية لـ error (4)

HTTP 401

Key مفقود أو غير صالح أو منتهي أو ملغى.

application/json

النوع
object
الحقول المطلوبة
error
  • errorobjectمطلوب
    الحقول الفرعية لـ error (4)

HTTP 403

صلاحيات IP أو الحساب أو النموذج أو الأداة غير كافية.

application/json

النوع
object
الحقول المطلوبة
error
  • errorobjectمطلوب
    الحقول الفرعية لـ error (4)

HTTP 404

الكائن/الإمكانية غير متاحين، أو مفتاح الميزة معطّل.

application/json

النوع
object
الحقول المطلوبة
error
  • errorobjectمطلوب
    الحقول الفرعية لـ error (4)

HTTP 409

تعارض في منع التكرار/عرض السعر، أو كائن غير جاهز، أو ما يزال مشارًا إليه.

application/json

النوع
object
الحقول المطلوبة
error
  • errorobjectمطلوب
    الحقول الفرعية لـ error (4)

HTTP 429

حد معدل الطلبات/قائمة الانتظار.

application/json

النوع
object
الحقول المطلوبة
error
  • errorobjectمطلوب
    الحقول الفرعية لـ error (4)

HTTP 500

فشل داخلي في المصادقة أو تخزين البيانات.

application/json

النوع
object
الحقول المطلوبة
error
  • errorobjectمطلوب
    الحقول الفرعية لـ error (4)

HTTP 503

الخدمة أو التسعير أو التخزين غير متاح.

application/json

النوع
object
الحقول المطلوبة
error
  • errorobjectمطلوب
    الحقول الفرعية لـ error (4)