الانتقال إلى المحتوى الرئيسي

المقدمة

تتيح لك البيانات الوصفية تخزين معلومات إضافية ومنظمة حول كائناتك في مدفوعات Dodo. يمكنك إرفاق البيانات الوصفية بمعظم كائنات مدفوعات Dodo، بما في ذلك المدفوعات والاشتراكات والمزيد.

نظرة عامة

  • يمكن أن تكون مفاتيح البيانات الوصفية بطول يصل إلى 40 حرفًا
  • يمكن أن تكون قيم البيانات الوصفية بطول يصل إلى 500 حرف
  • يمكنك أن تحتوي على ما يصل إلى 50 زوج مفتاح-قيمة من البيانات الوصفية لكل كائن
  • يجب أن تحتوي المفاتيح على أحرف أبجدية رقمية فقط، وشرطات، وشرطات سفلية
  • البيانات الوصفية ليست قابلة للبحث باستخدام واجهة برمجة التطبيقات الخاصة بنا ولكن يتم إرجاعها في استجابات واجهة برمجة التطبيقات وwebhooks

حالات الاستخدام

تكون البيانات الوصفية مفيدة لـ:
  • تخزين معرفات أو مراجع خارجية
  • إضافة تعليقات داخلية
  • ربط كائنات مدفوعات Dodo بنظامك
  • تصنيف المعاملات
  • إضافة سمات مخصصة للتقارير

إضافة البيانات الوصفية

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

عبر واجهة برمجة التطبيقات

عبر واجهة المستخدم في لوحة التحكم (للمنتجات فقط)

بالنسبة للمنتجات، يمكنك أيضًا إضافة البيانات الوصفية مباشرة من لوحة تحكم مدفوعات Dodo عند إنشاء أو تعديل منتج. تتيح لك قسم البيانات الوصفية إضافة أزواج مفتاح-قيمة مخصصة بسهولة دون كتابة كود.
Product metadata interface in Dodo Payments dashboard
استخدام واجهة لوحة التحكم لبيانات تعريف المنتج مفيد بشكل خاص لأعضاء الفريق غير التقنيين الذين يحتاجون إلى إدارة معلومات وفئات المنتج.

استرجاع البيانات الوصفية

تتضمن البيانات الوصفية في استجابات واجهة برمجة التطبيقات عند استرجاع الكائنات:

البحث والتصفية

بينما لا يمكن البحث عن البيانات الوصفية مباشرة عبر واجهة برمجة التطبيقات الخاصة بنا، يمكنك:
  1. تخزين المعرفات المهمة في البيانات الوصفية
  2. استرجاع الكائنات باستخدام معرفاتها الأساسية
  3. تصفية النتائج في كود التطبيق الخاص بك

أفضل الممارسات

افعل:

  • استخدم اتفاقيات تسمية متسقة لمفاتيح البيانات الوصفية
  • وثّق مخطط البيانات الوصفية داخليًا
  • اجعل القيم قصيرة ومعنوية
  • استخدم البيانات الوصفية للبيانات الثابتة فقط
  • فكّر في استخدام بادئات للأنظمة المختلفة (على سبيل المثال، crm_id، inventory_sku)

لا يجب عليك:

  • تخزين بيانات حساسة في البيانات الوصفية
  • استخدام البيانات الوصفية للقيم التي تتغير بشكل متكرر
  • الاعتماد على البيانات الوصفية للمنطق التجاري الحرج
  • تخزين معلومات مكررة متاحة في مكان آخر في الكائن
  • استخدام أحرف خاصة في مفاتيح البيانات الوصفية

الكائنات المدعومة

تدعم البيانات الوصفية الكائنات التالية:

Webhooks والبيانات الوصفية

تتضمن البيانات الوصفية في أحداث webhook، مما يسهل التعامل مع الإشعارات باستخدام بياناتك المخصصة:
آخر تعديل في ٢٨ مايو ٢٠٢٦