master
Mobin Kazemi 2 years ago
parent 6a8d002b8d
commit bfb4f0513b
  1. BIN
      .DS_Store
  2. 0
      Deployment & Installation/README.md
  3. BIN
      Deployment & Installation/v2_Deployment - App.docx
  4. BIN
      Deployment & Installation/v2_Deployment - DB.docx
  5. BIN
      Deployment & Installation/v2_Deployment - Gateway.docx
  6. BIN
      Deployment & Installation/v2_Deployment.docx
  7. BIN
      Help & API/#test.docx
  8. BIN
      Help & API/.DS_Store
  9. BIN
      Help & API/_old_v2_admin.docx
  10. BIN
      Help & API/_old_v2_airQuality.docx
  11. BIN
      Help & API/_old_v2_bpms_Help.docx
  12. BIN
      Help & API/_old_v2_calendar.docx
  13. BIN
      Help & API/_old_v2_checklist_Help.docx
  14. BIN
      Help & API/_old_v2_countryDivision_Help.docx
  15. BIN
      Help & API/_old_v2_drinkWaterUnit_Help.docx
  16. BIN
      Help & API/_old_v2_encryption_Help.docx
  17. BIN
      Help & API/_old_v2_evaluation_Help.docx
  18. BIN
      Help & API/_old_v2_guild_Help.docx
  19. BIN
      Help & API/_old_v2_healthCard_Help.docx
  20. BIN
      Help & API/_old_v2_healthCompliance_Help.docx
  21. BIN
      Help & API/_old_v2_helpService_Help.docx
  22. BIN
      Help & API/_old_v2_isic.docx
  23. BIN
      Help & API/_old_v2_isic_Help.docx
  24. BIN
      Help & API/_old_v2_jobHistory.docx
  25. BIN
      Help & API/_old_v2_level_help.docx
  26. BIN
      Help & API/_old_v2_menu_Help.docx
  27. BIN
      Help & API/_old_v2_question_Help.docx
  28. BIN
      Help & API/_old_v2_report_Help.docx
  29. BIN
      Help & API/_old_v2_samplingItems_Help.docx
  30. BIN
      Help & API/_old_v2_sms_Help.docx
  31. BIN
      Help & API/_old_v2_sso_Help.docx
  32. BIN
      Help & API/_old_v2_unit_Help.docx
  33. BIN
      Help & API/_old_v2_user_Help.docx
  34. BIN
      Help & API/_old_v2_waterSupply_Help.docx
  35. BIN
      Help & API/activation.docx
  36. BIN
      Help & API/book.docx
  37. BIN
      Help & API/category.docx
  38. BIN
      Help & API/comment.docx
  39. BIN
      Help & API/commentLike.docx
  40. BIN
      Help & API/content.docx
  41. BIN
      Help & API/~$mment user-story.docx
  42. 0
      Sofware Architecture/README.md
  43. BIN
      Sofware Architecture/v2_SoftwareArchitecture.docx
  44. BIN
      business rules/offCode business rules.docx
  45. 55
      document.js

BIN
.DS_Store vendored

Binary file not shown.

Binary file not shown.

BIN
Help & API/.DS_Store vendored

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

@ -0,0 +1,55 @@
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' },
]
}
]
}
Loading…
Cancel
Save