You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

55 lines
3.1 KiB

2 years ago
const doc = {
main: {
document: 'سرویس فعالسازی',
introduction: 'سرویس فعالسازی امکان فعالسازی قابلیت های AR و QR را برای کاربران ایجاد میکند. کاربران با استفاده از این سرویس به محتوای آن محصول دسترسی پیدا خواهند نمود'
},
items: [
{
description: 'افزودن کد فعالسازی',
route: 'https://{{base_url}}/activation/add',
method: 'POST',
isPublic: false,
enteries: [
{ key: 'productId', type: 'integer', required: true, desc: 'شناسه محصول' },
{ key: 'count', type: 'integer', required: true, desc: 'تعداد' },
{ key: 'format', type: 'string', required: false, desc: 'فرمت' },
{ key: 'isDemo', type: 'boolean', required: false, desc: 'کدها دمو است؟' },
],
response: {},
sample: [
{ productId: 3, count: 100, format: null, isDemo: false },
{ productId: 2, count: 10, format: null, isDemo: true },
]
},
// --
{
description: 'دریافت اطلاعات کد فعالسازی',
route: 'https://{{base_url}}/activation/info',
method: 'GET',
isPublic: false,
enteries: [
{ key: 'activationCode', type: 'string', required: true, desc: 'متن کد فعالسازی' },
],
response: [
{ key: 'id', type: 'integer', required: true, desc: 'شناسه کد' },
{ key: 'pid', type: 'integer', required: false, desc: 'شناسه بالا دست' },
{ key: 'ord', type: 'integer', required: false, desc: 'ترتیب' },
{ key: 'bookId', type: 'integer', required: true, desc: 'شناسه کتاب' },
{ key: 'productId', type: 'integer', required: true, desc: 'شناسه محصول' },
{ key: 'userProductId', type: 'integer', required: false, desc: 'شناسه محصول کاربر' },
{ key: 'activationCode', type: 'string', required: true, desc: 'متن کد' },
{ key: 'status', type: 'integer', required: true, desc: 'وضعیت' },
{ key: 'special', type: 'boolean', required: true, desc: 'کدهای خاص' },
{ key: 'productIds', type: 'integer', required: false, desc: 'شناسه محصولات' },
{ key: 'duration', type: 'integer', required: false, desc: 'مدت اعتبار' },
{ key: 'createdAt', type: 'timestamp', required: true, desc: 'تاریخ ایجاد' },
{ key: 'updatedAt', type: 'timestamp', required: true, desc: 'تاریخ ویرایش' },
{ key: 'deletedAt', type: 'timestamp', required: false, desc: 'تاریخ حذف' }
],
sample: [
{ activationCode: 'o8-0ogehds98q2oklry' },
]
}
]
}