الانتقال إلى المحتوى الرئيسي
POST
إنشاء نوع إيصال
ينشئ نوع إيصال مخصص للمستأجر مع مخطط JSON للتحقق من صحة الحمولة. الأنواع المحددة بواسطة النظام الأساسي (payment_receipt, security_event_receipt, delivery_receipt, compliance_receipt, custom_receipt) للقراءة فقط ولا يمكن تجاوزها أو استبدالها. يتم عزل الأنواع المخصصة للمستأجر المصادق عليه بواسطة أمان مستوى الصف. لا يمكن للمستأجرين الآخرين رؤية أو استخدام أنواعك المخصصة.

نص الطلب

متطلبات المخطط

يجب أن يكون الحقل schema مخطط JSON صالحًا (مسودة 2020-12). قم بتضمين مصفوفة required لفرض حقول الحمولة الإلزامية عند سك العملة.

تحديد الإصدارات

أنشئ إصدارات متعددة من نفس النوع عن طريق تمرير قيم version مختلفة (1.0.0، 2.0.0، إلخ). تقوم الإيصالات دائمًا بتثبيت الإصدار في وقت السك، لذا لا تتأثر الإيصالات الموجودة عند تقديم إصدار جديد. لإهمال إصدار قديم، استخدم PATCH /v1/receipt-types/{name} مع {"status": "deprecated"}.

الاستجابات

التفويضات

X-API-Key
string
header
مطلوب

مفتاح API للمصادقة من جهاز إلى جهاز

الجسم

application/json
display_name
string
مطلوب

اسم مقروء بشريًا

name
string
مطلوب

اسم نوع الإيصال القابل للقراءة آليًا

schema
any
مطلوب

مخطط JSON للتحقق من صحة الحمولة

description
string | null
version
string

الاستجابة

تم إنشاء نوع الإيصال

name
string
display_name
string
schema
object
created_at
string