المقدمة
تتيح لك metadata تخزين بياناتك المخصصة بصيغة مفتاح-قيمة على كائنات Dodo Payments، مثل معرّف طلب من نظامك أو مرجع CRM. يمكنك إرفاق metadata بمعظم الكائنات، بما في ذلك payments وsubscriptions وcustomers وproducts. راجع الكائنات المدعومة للاطلاع على القائمة الكاملة.نظرة عامة
تتبع metadata القواعد التالية:- يمكن أن يصل طول مفاتيح Metadata إلى 40 حرفًا (وإلى 100 حرف للأحداث المتعلقة بالاستخدام التي يتم إدخالها عبر
POST /events/ingest). - يمكن أن تكون قيم Metadata من نوع string أو integer أو number أو boolean. ويمكن أن يصل طول القيم النصية إلى 500 حرف.
- لا يتم قبول الكائنات والمصفوفات و
nullكقيم لـ Metadata. - يمكنك إضافة ما يصل إلى 50 زوجًا من مفتاح-قيمة Metadata لكل كائن. ويُرجع الطلب الذي يحتوي على عدد أكبر الخطأ
MAXIMUM_KEYS_REACHEDرمز الخطأ. - لا يمكن لـ API البحث في Metadata أو تصفيتها، ولكنه يعرض Metadata في استجابات API وwebhooks.
حالات الاستخدام
استخدم metadata من أجل:- تخزين المعرّفات أو المراجع الخارجية.
- إضافة ملاحظات داخلية.
- ربط كائنات Dodo Payments بالسجلات الموجودة في نظامك.
- تصنيف المعاملات.
- إضافة سمات مخصصة لإعداد التقارير.
إضافة metadata
أضف metadata عند إنشاء كائن أو تحديثه من خلال API. وبالنسبة إلى products، يمكنك أيضًا إضافة metadata من لوحة التحكم.عبر API
مرّر كائنmetadata في نص الطلب. تستخدم الأمثلة أدناه TypeScript SDK وتفترض تهيئة client:
عبر واجهة مستخدم لوحة التحكم (Products فقط)
لإضافة metadata إلى product دون كتابة تعليمات برمجية، افتح product في Products وأضف أزواج المفاتيح والقيم في قسم metadata. يمكنك القيام بذلك عند إنشاء product أو تحريره.
استرداد metadata
تتضمن استجابات API metadata عند استرداد كائن:لا يؤدي استرداد جلسة checkout (
GET /checkouts/{id}) إلى إرجاع metadata. تحتوي استجابة حالة الجلسة على id وcreated_at وpayment_id وpayment_status وcustomer_email وcustomer_name فقط. لقراءة metadata التي أرفقتها عند إنشاء الجلسة، استرد payment الناتج باستخدام payment_id المُعاد.البحث والتصفية
لا يمكن لواجهة API البحث باستخدام metadata. للعثور على كائن باستخدام قيمة metadata:- خزّن المعرّفات المهمة في metadata.
- اعرض الكائنات أو استردها من خلال API.
- صفِّ النتائج في تعليمات التطبيق البرمجية.
أفضل الممارسات
اتبع هذه الإرشادات للحفاظ على فائدة metadata.افعل:
- استخدم اصطلاحات تسمية متسقة لمفاتيح metadata.
- وثّق مخطط metadata داخليًا.
- حافظ على قِصر القيم ووضوح معناها.
- استخدم metadata للبيانات الثابتة فقط.
- ضع في اعتبارك استخدام بادئات توضّح اسم النظام المصدر، مثل
crm_idأوinventory_sku.
لا تفعل:
- تخزّن البيانات الحساسة في metadata.
- تستخدم metadata للقيم التي تتغير كثيرًا.
- تعتمد على metadata في منطق الأعمال المهم.
- تكرّر المعلومات التي يحتوي عليها الكائن بالفعل.
- تستخدم أحرفًا خاصة في مفاتيح metadata.