عضو شو و شروع کن!

عضویت در سرویس اشتراک ویدئو اینما به راحتی با یک شماره همراه انجام می‌گردد. برای این کار کافیست به صفحه "ورود یا عضویت" سایت اینما مراجعه کنید و پس از درج و تایید شماره همراه خود، منتظر دریافت پیامک کد فعال سازی بمانید. با وارد کردن کد فعال سازی، وارد ناحیه کاربری خود خواهید شد و می‌توانید از تمامی امکانات سامانه اینما استفاده کنید.


دریافت API KEY

پس از ورود به سایت اینما، از منوی بازشونده روبروی مشخصات کاربر، وارد زیر منوی "ویرایش پروفایل" شوید، سپس عبارت موجود در کادر API-Key ، را کپی کنید . API-Key همان Token اتصال جهت احراز هویت نرم افزار شما می‌باشد. بنابراین از این پس، هر قسمتی که نیاز به فراخوانی Token باشد، می‌بایست همان عبارت موجود در بخش API-Key را وارد نمایید.


نحوه ارسال متد ها

به خاطر داشته باشید جهت ارسال اطلاعات خودتان به سرور اینما (eNama) حتما اطلاعات را به صورت FormData در قالب متد Post ارسال نمایید.


وب سرویس در جواب درخواست شما، یک آرایه JSON خروجی خواهد داد، که ساختار استاندارد آن برای تمامی خروجی ها به شکل زیر خواهد بود.

ساختار JSON خروجی

عنوان نوع توضیحات
Item Object در بدنه این فیلد، اکثر جواب‌های مورد نیازتان را دریافت خواهید کرد.
FilterRequest Object در بدنه این فیلد، شما جواب‌هایی دریافت خواهید کرد که به آن ها نیاز نخواهید داشت.
IsError Boolean در صورتی که درخواست شما با خطا مواجه شود، در این فیلد، مقدار "True" و در صورتی که عملیات با موفقیت انجام گردد، مقدار "False" نمایش داده خواهد شد.
Code int پس از ارسال درخواست‌ها، عددی به عنوان نتیجه در این فیلد نمایش داده می‌شود که معانی آن در جدول زیر درج شده است.

ساختار Code های وب سرویس

مقدار Code توضحیات
1درخواست موفقیت آمیز بوده
1-اطلاعات ارسالی وجود ندارد
2-درخواست با خطا مواجه شد
3-اطلاعات وارد شده کامل نیست
4-اطلاعاتی وجود ندارد
5-محدودیت درخواست درلحظه

دریافت اطلاعات پایه

با تکمیل فیلدهایی که در این بخش درج شده است، می‌توانید اطلاعات پایه از جمله نام دسته بندی‌ها، اطلاعات پایه پروفایل، اطلاعات مرتبط به ویدئوها و اطلاعات کانالی که در اکانت اینما ساخته‌اید را دریافت نمایید. برای دسترسی به برخی از این اطلاعات نیاز است که مقدار Token را با همان مقداری که در بخش API-Key درج شده است، تکمیل کنید.

ورودی های وب سرویس

نام فیلد توضیحات الزام پارامتر نوع داده
Token توکن احراز هویت به هنگام اتصال به وب سرویس اختیاری API KEY

آدرس وب سرویس دریافت اطلاعات پایه

https://api.enama.ir/Base/Get

ساختار Item در بدنه JSON

عنواننوعتوضیحات
ChanelListArrayلیستی از کانال‌های حساب کاربری اینمای شما. در صورتی که هیچ کانالی موجود نباشد، مقدار Null نمایش داده می‌شود.
LanguageArrayلیستی از زبان ها، در این مستند نیازی به استفاده از این فیلد ندارید (توضیحات تکمیلی در مستندات بعدی)
LicenseArrayلیستی از انواع لایسنس‌ها، در این مستند نیازی به استفاده از این فیلد ندارید (توضیحات تکمیلی در مستندات بعدی)
MonetizeArrayلیستی از نحوه درآمد زایی ویدئو، در این مستند نیازی به استفاده از این فیلد ندارید (توضیحات تکمیلی در مستندات بعدی)
OrientationArrayلیستی از جهت پخش ویدئو(Portrate/Landscape)، در این مستند نیازی به استفاده از این فیلد ندارید (توضیحات تکمیلی در مستندات بعدی)
PrivacyModeArrayلیستی از نحوه دسترسی، در این مستند نیازی به استفاده از این فیلد ندارید (توضیحات تکمیلی در مستندات بعدی)
CategoryArrayلیستی از Objectها که برای هر شی یک دسته‌بندی وجود دارد. این دسته بندی‌ها جهت بارگذاری، ویرایش و جستجوی ویدئوهای مشابه مورد نیاز شما قرار خواهد گرفت.
QualityArrayلیستی از کیفیت‌های قابل پخش، برای هر ویدئوی در حال نمایش
StatusArrayلیستی از وضعیت ویدئوهای بارگذاری شده
SubscribeArrayدر بدنه ChannelList، این آیتم به صورت آرایه ارسال می‌گردد. در صورتی که Token وارد شده باشد، نشان می‌دهد آن Token در آن کانال عضو است.

نمونه پاسخ وب سرویس


    {
    "Item": {
            "ChanelList": [
                {
                    "ChanelID": 12345,
                    "ChanelUsersID": 1234567,
                    "ChanelTitle": "enama",
                    "ChanelIsPaymentForChannel": false,
                    "UsersID": 12345,
                    "ObjectCollection": null,
                    "Subscribe": [
                             {
                                 "IsSubscribe": 12345,
                                 "CID": 12345
                             }
                        ]
                }
            ],
            "Language": [
                {
                "LanguageID": 2,
                "LanguageLable": "Subtitle"
                },
                {
                "LanguageID": 1,
                "LanguageLable": "None Subtitle"
                }
            ],
            "License": [
                {
                "LicenseID": 1,
                "LicenseLable": "رایگان - عمومی"
                }
            ],
            "Monetize": [
                {
                "MonetizeID": 2,
                "MonetizeLable": "بدون تبلیغات"
                },
                {
                "MonetizeID": 1,
                "MonetizeLable": "ایجاد درآمد"
                }
            ],
            "Orientation": [
                {
                "OrientationID": 2,
                "OrientationLable": "افقی"
                },
                {
                "OrientationID": 1,
                "OrientationLable": "عمودی"
                }
            ],
            "PrivacyMode": [
                {
                "PrivacyModeID": 3,
                "PrivacyModeLable": "دیگر"
                },
                {
                "PrivacyModeID": 2,
                "PrivacyModeLable": "کپی"
                },
                {
                "PrivacyModeID": 1,
                "PrivacyModeLable": "تولید شخصی"
                }
            ],
            "Category": [
                {
                "CategoryID": 24,
                "CategoryLable": "آرایشی و بهداشتی"
                },
                {
                "CategoryID": 21,
                "CategoryLable": "آشپزی"
                },
                {
                "CategoryID": 4,
                "CategoryLable": "آموزش و پژوهش"
                },
                {
                "CategoryID": 30,
                "CategoryLable": "الکترونیک و دیجیتال"
                },
                {
                "CategoryID": 3,
                "CategoryLable": "بازی"
                },
                {
                "CategoryID": 19,
                "CategoryLable": "بانوان"
                },
                {
                "CategoryID": 20,
                "CategoryLable": "پزشکی و سلامت"
                },
                {
                "CategoryID": 25,
                "CategoryLable": "پوشاک"
                },
                {
                "CategoryID": 5,
                "CategoryLable": "تفریحی"
                },
                {
                "CategoryID": 17,
                "CategoryLable": "چاپ و تبلیعات"
                },
                {
                "CategoryID": 31,
                "CategoryLable": "حمل و نقل"
                },
                {
                "CategoryID": 13,
                "CategoryLable": "حوادث"
                },
                {
                "CategoryID": 15,
                "CategoryLable": "حیوانات"
                },
                {
                "CategoryID": 9,
                "CategoryLable": "خبری"
                },
                {
                "CategoryID": 26,
                "CategoryLable": "خدمات ساختمانی"
                },
                {
                "CategoryID": 27,
                "CategoryLable": "خدمات عمومی"
                },
                {
                "CategoryID": 32,
                "CategoryLable": "خودرو و وسایل نقلیه"
                },
                {
                "CategoryID": 99,
                "CategoryLable": "سایر"
                },
                {
                "CategoryID": 14,
                "CategoryLable": "سفر و گردشگری"
                },
                {
                "CategoryID": 23,
                "CategoryLable": "سمینار"
                },
                {
                "CategoryID": 10,
                "CategoryLable": "سیاسی"
                },
                {
                "CategoryID": 29,
                "CategoryLable": "صنعت و کشاورزی"
                },
                {
                "CategoryID": 2,
                "CategoryLable": "طنز"
                },
                {
                "CategoryID": 11,
                "CategoryLable": "علم و تکنولوژی"
                },
                {
                "CategoryID": 28,
                "CategoryLable": "غذا و رستوران"
                },
                {
                "CategoryID": 6,
                "CategoryLable": "فیلم"
                },
                {
                "CategoryID": 7,
                "CategoryLable": "مذهبی"
                },
                {
                "CategoryID": 22,
                "CategoryLable": "معرفی اشخاص"
                },
                {
                "CategoryID": 8,
                "CategoryLable": "موسیقی"
                },
                {
                "CategoryID": 18,
                "CategoryLable": "هنری"
                },
                {
                "CategoryID": 12,
                "CategoryLable": "ورزش"
                },
                {
                "CategoryID": 1,
                "CategoryLable": "کارتون"
                }
        ],
        "Quality": [
                {
                "QualityID": 6,
                "QualityLable": "240"
                },
                {
                "QualityID": 5,
                "QualityLable": "Other"
                },
                {
                "QualityID": 4,
                "QualityLable": "1280"
                },
                {
                "QualityID": 3,
                "QualityLable": "1080"
                },
                {
                "QualityID": 2,
                "QualityLable": "720"
                },
                {
                "QualityID": 1,
                "QualityLable": "480"
                }
        ],
        "Status": [
                {
                "StatusID": 8,
                "StatusName": "Duplicate Data",
                "StatusCSS": null
                },
                {
                "StatusID": 7,
                "StatusName": "W8Publish",
                "StatusCSS": null
                },
                {
                "StatusID": 6,
                "StatusName": "Downloaded",
                "StatusCSS": null
                },
                {
                "StatusID": 5,
                "StatusName": "OnQueue Download",
                "StatusCSS": null
                },
                {
                "StatusID": 4,
                "StatusName": "بلاک محتوا",
                "StatusCSS": null
                },
                {
                "StatusID": 3,
                "StatusName": "Error Convert",
                "StatusCSS": null
                },
                {
                "StatusID": 2,
                "StatusName": "Published",
                "StatusCSS": null
                },
                {
                "StatusID": 1,
                "StatusName": "New Uploaded",
                "StatusCSS": ""
                }
        ]
    },
    "FilterRequest": {
        "IsHome": 0,
        "Keyword": null,
        "ChanelName": null,
        "SortBy": 0,
        "ObjectID": 0,
        "ObjectNotID": 0,
        "Suggestion": 0,
        "Relative": 0,
        "MyConvertList": 0,
        "ChanelID": 0,
        "UXD": 0,
        "MySubscribe": 0,
        "IsMyChannel": 0,
        "LastLoadID": 0,
        "CategoryID": 0,
        "StatusID": 0,
        "ServerID": 0,
        "OrientationID": 0,
        "MonetizeID": 0,
        "LicenseID": 0,
        "LanguageID": 0,
        "TypeFileID": 0,
        "HashtagID": 0,
        "QualityID": 0,
        "PageSize": 0,
        "PageIndex": 0,
        "Privacy": 0,
        "Token": null,
        "MyHistory": 0,
        "MyLiked": 0,
        "MyWatchLiST": 0,
        "ChannelKey": null
    },
    "IsError": false,
    "Code": -3
    }

دریافت ویدئوها

شما می توانید با استفاده از اطلاعات زیر، به ویدئوهای سایت اینما دسترسی داشته باشید.

ورودی‌های وب سرویس

نام فیلد توضیحات الزام پارامتر نوع
Token توکن اتصال، جهت احراز هویت اختیاری API-KEY
ChanelID جهت دریافت ویدئوهای یک کانال خاص اجباری است. اختیاری String
ChannelKey جهت دریافت ویدئوهای یک کانال خاص اجباری است. اختیاری به صورت یک کلید منحصر به فرد
ObjectID جهت دریافت یک ویدئو خاص اختیاری آیدی ویدیو
CategoryID جهت دریافت ویدئو از یک دسته بندی خاص اختیاری آیدی دسته بندی
HashtagID جهت دریافت ویدئو، دارای یک هشتگ خاص اختیاری آیدی هشتگ
Keyword برای جستجوی ویدیو ها با این کلید واژه اختیاری String
MyLiked برای دریافت ویدئوهایی که لایک کرده‌اید، می‌بایست مقدار 1 و در غیر اینصورت، مقدار 1- را وارد گردد. اختیاری int
MyHistory برای دریافت ویدئوهایی که قبلا دیده‌اید مقدار 1 و در غیر اینصورت مقدار 1- وارد گردد. اختیاری int
MyWatchLiST برای دریافت ویدئوهایی که ذخیره کرده‌اید، مقدار 1 و در غیر اینصورت مقدار 1- وارد گردد. اختیاری int
PageSize با تغییر این فیلد می‌توانید در هر درخواست تعداد مشخصی ویدئو دریافت کنید که به صورت پیشفرض این عدد 20 و در بیشترین حالت این عدد 50 می‌تواند باشد. برای مثال اگر PageSize را 20 قرار دهید، در هر صفحه 20 عدد ویدئو نمایش داده خواهد شد. اختیاری int
PageIndex با تغییر این فیلد می‌توانید تعداد بیشتری ویدئو در هر صفحه دریافت کنید. این عدد به صورت پیشفرض از 0 شروع می شود.اگر PageIndex صفر باشد، در صفحه اول، به تعدادی که در PageSizeتعیین کرده‌اید، آخرین ویدئوها نمایش داده خواهد شد. اختیاری int

برای مثال:

  • در صورتی که می‌خواهید ویدئویی را با کلمه‌ی کلیدی خاصی جستجو نمایید می بایست اطلاعات Page Index, Page Size, Token و Keyword=”کرونا” را ارسال نمایید.
  • جهت دریافت ویدئوهای یک کانال با آیدی خاص، می‌بایست اطلاعات Token, Page Index, Page Size و ChanelID = "1234 " را ارسال نمایید.

نکته‌ی قابل توجه این است که می‌توانید اطلاعات Page Index و Page Size را ارسال نکنید. حتی در صورتی که مقداری برای Token نداشته باشید، نیازی به ارسال Token نمی‌باشد.

وب سرویس دریافت ویدیو ها

https://api.enama.ir/Object/List

ساختار Item در بدنه JSON

عنواننوعتوضیحات
[]Arrayلیستی از ویدئوها، در صورتی که ویدئویی وجود نداشته باشد، null خواهد بود.

نمونه پاسخ وب سرویس


    {
    "Item": [
            {
                "ObjectIsPaymentForPlay": false,
                "ObjectPayment": 0,
                "ObjectID": 24663,
                "ObjectUsersID": 1013673,
                "ObjectChanelID": 23882,
                "ObjectStatusID": 2,
                "ObjectServerID": 3,
                "ObjectOrientationID": 2,
                "ObjectPrivacyModeID": 3,
                "ObjectMonetizeID": 2,
                "ObjectLicenseID": 1,
                "ObjectLanguageID": 1,
                "ObjectFileTypeID": 1,
                "ObjectFileName": "",
                "ObjectTitle": "سرطان حمید هیراد",
                "ObjectDownloadUrl": "",
                "ObjectAbout": "حمید هیراد بازبان خودش گفت فقط تا یک ماه زنده است",
                "ObjectDuration": "00:00:59",
                "ObjectTotalLike": 0,
                "ObjectTotalComment": 0,
                "ObjectTotalTimePlayed": "00:00:00",
                "ObjectCreateDate": "2020-06-12T16:20:51",
                "ObjectTotalPlayed": 7,
                "ObjectScore": 1,
                "UsersID": 1013673,
                "ChanelIsPaymentForChannel": false,
                "Chanel1Month": 0,
                "Chanel3Month": 0,
                "Chanel6Month": 0,
                "Chanel12Month": 0,
                "ChanelUsersID": 1013673,
                "ChanelID": 23882,
                "ChanelTitle": "کاربر_ 6224",
                "ChanelAbout": "",
                "ChanelUniqueID": "C101367311592020590601",
                "ChanelLogo": "NoFile",
                "ChanelCover": "NoFile",
                "ChanelTotalViewed": 20,
                "ChanelTotalSubscribe": 1,
                "ChanelTotalVideo": 3,
                "StatusID": 2,
                "StatusName": "Published",
                "StatusCSS": null,
                "ServerID": 3,
                "ServerURL": "https://evod3.cdn.enama.ir",
                "OrientationID": 2,
                "OrientationLable": "افقی",
                "PrivacyModeID": 3,
                "PrivacyModeLable": "دیگر",
                "MonetizeID": 2,
                "MonetizeLable": "بدون تبلیغات",
                "LicenseID": 1,
                "LicenseLable": "رایگان - عمومی",
                "LanguageID": 1,
                "LanguageLable": "None Subtitle",
                "FileTypeID": 1,
                "FileTypeLable": "MP4",
                "WatchLaterList": null,
                "IsLike": null,
                "IsView": null,
                "Hashtags": null,
                "Categorys": [
                    {
                        "CategoryID": 6,
                        "CategoryLable": "فیلم",
                        "OID": 24663
                    },
                    {
                        "CategoryID": 8,
                        "CategoryLable": "موسیقی",
                        "OID": 24663
                    }   
                ],
                "Quality": [
                    {
                        "QualityID": 1,
                        "QualityLable": "480",
                        "OID": 24663
                    },
                    {
                        "QualityID": 6,
                        "QualityLable": "240",
                        "OID": 24663
                    }
                ]
            }
    ],
    "FilterRequest": {
            "IsHome": 1,
            "Keyword": "",
            "ChanelName": "",
            "SortBy": 1,
            "ObjectID": -1,
            "ObjectNotID": -1,
            "Suggestion": -1,
            "Relative": -1,
            "MyConvertList": -1,
            "ChanelID": -1,
            "UXD": -1,
            "MySubscribe": -1,
            "IsMyChannel": -1,
            "LastLoadID": -1,
            "CategoryID": -1,
            "StatusID": 0,
            "ServerID": 0,
            "OrientationID": -1,
            "MonetizeID": -1,
            "LicenseID": -1,
            "LanguageID": -1,
            "TypeFileID": -1,
            "HashtagID": -1,
            "QualityID": -1,
            "PageSize": 24,
            "PageIndex": 0,
            "Privacy": -1,
            "Token": "****-****-****-****",
            "MyHistory": -1,
            "MyLiked": -1,
            "MyWatchLiST": -1,
            "ChannelKey": "NoneChannel"
    },
    "IsError": false,
    "Code": 0
    }

بارگذاری ویدئو

برای بارگذاری فایل ویدئوها می‌بایست از اطلاعات زیر استفاده نمایید.

ورودی های وب سرویس

نام فیلد توضیحات الزام پارامتر نوع
Token توکن اتصال، جهت احراز هویت اجباری API KEY
Title وارد کردن عنوان ویدئو، ضروری می‌باشد و تا 100 کاراکتر قابل قبول است. اجباری String
About توضیحات ویدئو اختیاری بوده و در صورت عدم تکمیل، می‌تواند خالی باشد. اختیاری String
ChanelID آیدی کانال اجباری بوده و می بایست آی دی کانالی که می‌خواهید ویدئو در آن بارگذاری گردد، وارد شود. اجباری String
ObjectFile فایل ویدئو که می‌خواهید آپلود کنید و می‌بایست به صورت باینری ارسال گردد. اجباری Binary
CategoryID دسته بندی ویدئو که باید بین 1 تا حداکثر 3 مورد ارسال گردد. به طور مثال 1,3 اجباری String
Hashtags هشتگ های مرتبط با ویدئو که حداکثر می تواند تا 5 مورد ارسال گردد. اختیاری String
CoverVideo کاور ویدیو جهت نمایش اختیاری Base64
TypeUpload عدد 1 برای آپلود ویدئو و عدد 4 برای آپلود موسیقی می‌بایست ارسال گردد. اختیاری int
srtFile اگر ویدئو زبان اصلی باشد، زیر نویس میبایست به صورت باینری ارسال گردد. اختیاری File

آدرس وب سرویس بارگذاری ویدیو

https://api.enama.ir/Object/Post

ساختار JSON در بارگذاری

عنواننوعتوضیحات
ItemObjectدر صورتی که بارگذاری ویدئو به صورت صحیح انجام شود، null خواهد بود.
Codeintدر صورتی که بارگذاری ویدئو به درستی انجام گردد، مقدار 1 خواهد بود.
IsErrorBooleanدر صورتی که بارگذاری ویدئو به درستی انجام گردد False و در صورتی که بارگذاری با خطا مواجه شود True خواهد بود.

نمونه پاسخ وب سرویس


    {
        "Item":null,
        "FilterRequest":{
                "IsHome":-1,
                "Keyword":"",
                "ChanelName":"",
                "SortBy":-1,
                "ObjectID":12345,
                "ObjectNotID":-1,
                "Suggestion":-1,
                "Relative":-1,
                "MyConvertList":-1,
                "ChanelID":12345,
                "UXD":-1,
                "MySubscribe":-1,
                "IsMyChannel":-1,
                "LastLoadID":-1,
                "CategoryID":-1,
                "StatusID":0,
                "ServerID":0,
                "OrientationID":-1,
                "MonetizeID":2,
                "LicenseID":-1,
                "LanguageID":-1,
                "TypeFileID":-1,
                "HashtagID":-1,
                "QualityID":-1,
                "PageSize":20,
                "PageIndex":0,
                "Privacy":-1,
                "Token":"****-****-****-****",
                "MyHistory":-1,
                "MyLiked":-1,
                "MyWatchLiST":-1,
                "ChannelKey":"NoneChannel"
        },
        "IsError":false,
        "Code":1
    }



ویرایش ویدیو

در بخش ویرایش ویدئو، می‌بایست با همان متد بارگذاری ویدئو و همچنین ورود اطلاعات زیر، فایل موجود را ویرایش نمایید.

ورودی های وب سرویس

نام فیلد توضیحات الزام پارامتر نوع
Token توکن اتصال، جهت احراز هویت اجباری است API KEY
Title وارد کردن عنوان ویدئو، ضروری می‌باشد و تا 100 کاراکتر قابل قبول است. اجباری است String
About توضیحات ویدئو اختیاری بوده و در صورت عدم تکمیل، می‌تواند خالی باشد. اختیاری است String
ChanelID آیدی کانالی که ویدئو در آن بارگذاری شده است و حتما باید تکمیل گردد. اجباری است String
RecordID آیدی ویدئویی که در حال ویرایش است اجباری است String
CategoryID دسته بندی ویدئو که باید بین 1 تا حداکثر 3 مورد ارسال گردد. به طور مثال 1,3 اجباری است String
Hashtags هشتگ های مرتبط با ویدئو که حداکثر می تواند تا 5 مورد ارسال گردد. اختیاری است String
CoverVideo کاور ویدئو جهت ویرایش اختیاری است Base64
TypeUpload عدد 1 برای آپلود ویدئو و عدد 4 برای آپلود موسیقی می‌بایست ارسال گردد. اجباری است int
srtFile اگر ویدئو زبان اصلی باشد، زیر نویس می‌بایست به صورت باینری ارسال گردد. اختیاری است File

آدرس وب سرویس ویرایش ویدیو

https://api.enama.ir/Object/Post

ساختار Item در بدنه JSON

عنواننوعتوضیحات
{}Objectدر صورتی که ویرایش بدون هیچ خطایی انجام گردد، شی ویدئو در جواب برای شما ارسال می‌گردد و در صورتی که ویرایش با خطا مواجه شود، ارسال شی ویدئو انجام نخواهد شد.

نمونه پاسخ وب سرویس


    {
    "Item": [
        {
            "ObjectIsPaymentForPlay": false,
            "ObjectPayment": 0,
            "ObjectID": 12345,
            "ObjectUsersID": 1234567,
            "ObjectChanelID": 11934,
            "ObjectStatusID": 2,
            "ObjectServerID": 1,
            "ObjectOrientationID": 2,
            "ObjectPrivacyModeID": 3,
            "ObjectMonetizeID": 2,
            "ObjectLicenseID": 1,
            "ObjectLanguageID": 1,
            "ObjectFileTypeID": 1,
            "ObjectFileName": "",
            "ObjectTitle": "طبیعت",
            "ObjectDownloadUrl": "",
            "ObjectAbout": "",
            "ObjectDuration": "00:00:19",
            "ObjectTotalLike": 0,
            "ObjectTotalComment": 0,
            "ObjectTotalTimePlayed": "00:00:00",
            "ObjectCreateDate": "2020-05-06T11:09:42",
            "ObjectTotalPlayed": 18,
            "ObjectScore": 1,
            "UsersID": 1234567,
            "ChanelIsPaymentForChannel": false,
            "Chanel1Month": 0,
            "Chanel3Month": 0,
            "Chanel6Month": 0,
            "Chanel12Month": 0,
            "ChanelUsersID": 1234567,
            "ChanelID": 123455,
            "ChanelTitle": "Senator",
            "ChanelAbout": "Welcome To My Page
            ",
            "ChanelUniqueID": "enama.ir",
            "ChanelLogo": "NoFile",
            "ChanelCover": "NoFile",
            "ChanelTotalViewed": 81,
            "ChanelTotalSubscribe": 3,
            "ChanelTotalVideo": 5,
            "StatusID": 2,
            "StatusName": "Published",
            "StatusCSS": null,
            "ServerID": 1,
            "ServerURL": "https://evod1.cdn.enama.ir",
            "OrientationID": 2,
            "OrientationLable": "افقی",
            "PrivacyModeID": 3,
            "PrivacyModeLable": "دیگر",
            "MonetizeID": 2,
            "MonetizeLable": "بدون تبلیغات",
            "LicenseID": 1,
            "LicenseLable": "رایگان - عمومی",
            "LanguageID": 1,
            "LanguageLable": "None Subtitle",
            "FileTypeID": 1,
            "FileTypeLable": "MP4",
            "StatusPlayer": [
                {
                    "AllowPlay": 1,
                    "OID": 12345,
                    "TokenPlayer": "LCT-iLoFD05Zn38nYrZ2ZQ/1592040842",
                    "DownloadToken": "44-45-6B-53-35-39-73-75-6B-66-45-66-4B-42-6F-5A-32-55-6C-4C-66-57-43-2B-2B-58-61-6B-48-54-36-61-65-74-71-46-6A-42-61-63-35-4A-48-68-65-6F-30-51-30-59-7A-56-77-41-3D-3D"
                }
            ],
            "AdsStart": [
                {
                    "VID": 2,
                    "Title": "eNama Video Banner",
                    "Price": 121,
                    "Description": "https://sv1.cdn.enama.ir/mp4vid/1/ObjectVideo/1252771_,720,480,.mp4.urlset/master.m3u8",
                    "URLLink": "https://icvi.ir/makemoney",
                    "PTOP": 0,
                    "PLEFT": 0,
                    "PBOTTOM": 0,
                    "PRIGHT": 0,
                    "FNAME": "enama_video.mp4",
                    "ST": "00:00:00",
                    "ET": "00:00:10",
                    "OID": 11680
                }
            ],
            "AdsRight": [
                {
                    "VID": 15,
                    "Title": "iNoti Banner 1",
                    "Price": 0,
                    "Description": "0",
                    "URLLink": "https://inoti.com/",
                    "PTOP": 0,
                    "PLEFT": 0,
                    "PBOTTOM": 0,
                    "PRIGHT": 0,
                    "FNAME": "iNotiAds.gif",
                    "ST": "00:00:00",
                    "ET": "00:00:00",
                    "OID": 11680
                },
                {
                    "VID": 5,
                    "Title": "Banner TEST2",
                    "Price": 121,
                    "Description": " ",
                    "URLLink": "https://icvi.ir/makemoney",
                    "PTOP": 0,
                    "PLEFT": 0,
                    "PBOTTOM": 0,
                    "PRIGHT": 0,
                    "FNAME": "A11.gif",
                    "ST": "00:00:00",
                    "ET": "00:00:10",
                    "OID": 11680
                }
            ],
            "AdsBottom": [
                {
                    "VID": 7,
                    "Title": "Banner TEST4",
                    "Price": 121,
                    "Description": " ",
                    "URLLink": "https://icvi.ir/makemoney",
                    "PTOP": 0,
                    "PLEFT": 0,
                    "PBOTTOM": 0,
                    "PRIGHT": 0,
                    "FNAME": "A10.gif",
                    "ST": "00:00:00",
                    "ET": "00:00:10",
                    "OID": 11680
                }
            ],
            "Subscribe": null,
            "WatchLaterList": null,
            "IsLike": null,
            "IsView": [
                {
                    "IsView": 14983,
                    "Duration": "00:00:19",
                    "ViewedDuration": 11,
                    "OID": 12345
                }
            ],
            "Hashtags": null,
            "Categorys": [
                {
                    "CategoryID": 99,
                    "CategoryLable": "سایر",
                    "OID": 11680
                }
            ],
            "Quality": [
                {
                    "QualityID": 1,
                    "QualityLable": "480",
                    "OID": 12345
                },
                {
                    "QualityID": 6,
                    "QualityLable": "240",
                    "OID": 12345
                }
            ]
            }
    ],
    "FilterRequest": {
        "IsHome": -1,
        "Keyword": "",
        "ChanelName": "",
        "SortBy": -1,
        "ObjectID": 12345,
        "ObjectNotID": -1,
        "Suggestion": -1,
        "Relative": -1,
        "MyConvertList": -1,
        "ChanelID": 11934,
        "UXD": -1,
        "MySubscribe": -1,
        "IsMyChannel": -1,
        "LastLoadID": -1,
        "CategoryID": -1,
        "StatusID": 0,
        "ServerID": 0,
        "OrientationID": -1,
        "MonetizeID": 2,
        "LicenseID": -1,
        "LanguageID": -1,
        "TypeFileID": -1,
        "HashtagID": -1,
        "QualityID": -1,
        "PageSize": 20,
        "PageIndex": 0,
        "Privacy": -1,
        "Token": "****-****-****-****",
        "MyHistory": -1,
        "MyLiked": -1,
        "MyWatchLiST": -1,
        "ChannelKey": "NoneChannel"
        },
    "IsError": false,
    "Code": 1
    }

Like یا UnLike ویدئو

در صورتی که با حساب کاربری خود وارد سایت اینما شوید، امکان Like و Unlike ویدئوها، فعال می‌گردد.

نام فیلد توضیحات الزام پارامتر نوع
Token توکن، جهت احراز هویت اجباری API KEY
RecordID آیدی ویدئویی که می‌خواهید Like یا UnLike کنید اجباری String

وب سرویس درخواست Likeیا unLike ویدیو

https://api.enama.ir/Object/Like

ساختار Item در بدنه JSON

عنواننوعتوضیحات
{}Statusدر صورتی که عملیات انجام گردد، در بدنه Item، وضعیت True بوده و در صورتی که عملیات انجام نگردد False خواهد بود.

نمونه پاسخ وب سرویس


    {
    "Item":{"Status":true},
    "FilterRequest":{
            "IsHome":0,
            "Keyword":null,
            "ChanelName":null,
            "SortBy":0,
            "ObjectID":0,
            "ObjectNotID":0,
            "Suggestion":0,
            "Relative":0,
            "MyConvertList":0,
            "ChanelID":0,
            "UXD":0,
            "MySubscribe":0,
            "IsMyChannel":0,
            "LastLoadID":0,
            "CategoryID":0,
            "StatusID":0,
            "ServerID":0,
            "OrientationID":0,
            "MonetizeID":0,
            "LicenseID":0,
            "LanguageID":0,
            "TypeFileID":0,
            "HashtagID":0,
            "QualityID":0,
            "PageSize":0,
            "PageIndex":0,
            "Privacy":0,
            "Token":null,
            "MyHistory":0,
            "MyLiked":0,
            "MyWatchLiST":0,
            "ChannelKey":null},
    "IsError":false,
    "Code":1
    }


درخواست ذخیره سازی ویدئو

درصورتی که با حساب کاربری خود در سایت اینما وارد شده باشید، امکان ذخیره ویدئوهای دلخواه را در لیست ذخیره خواهید داشت همچنین می‌توانید با استفاده از این متد ویدئو مورد نظر را از لیست ذخیره حذف نمایید.

نام فیلد توضیحات الزام پارامتر نوع
Token توکن اتصال، جهت احراز هویت اجباری API KEY
RecordID آیدی ویدئویی که می‌خواهید آن را به لیست ذخیره اضافه کنید و یا از لیست ذخیره پاک کنید اجباری String

آدرس وب سرویس درخواست ذخیره یا حذف ویدئو از لیست ذخیره

https://api.enama.ir/Object/WatchLater

ساختار Item در بدنه JSON

عنواننوعتوضیحات
{}Statusدر صورتی که عملیات انجام گردد، در بدنه Item، وضعیت True بوده و در صورتی که عملیات انجام نگردد False خواهد بود.

نمونه پاسخ وب سرویس


    {
    "Item":{"Status":true},
    "FilterRequest":{
            "IsHome":0,
            "Keyword":null,
            "ChanelName":null,
            "SortBy":0,
            "ObjectID":0,
            "ObjectNotID":0,
            "Suggestion":0,
            "Relative":0,
            "MyConvertList":0,
            "ChanelID":0,
            "UXD":0,
            "MySubscribe":0,
            "IsMyChannel":0,
            "LastLoadID":0,
            "CategoryID":0,
            "StatusID":0,
            "ServerID":0,
            "OrientationID":0,
            "MonetizeID":0,
            "LicenseID":0,
            "LanguageID":0,
            "TypeFileID":0,
            "HashtagID":0,
            "QualityID":0,
            "PageSize":0,
            "PageIndex":0,
            "Privacy":0,
            "Token":null,
            "MyHistory":0,
            "MyLiked":0,
            "MyWatchLiST":0,
            "ChannelKey":null},
    "IsError":false,
    "Code":1
    }


درخواست حذف ویدئو

با این متد می توانید ویدئو خود را حذف کنید.

نام فیلد توضیحات الزام پارامتر نوع
Token توکن اتصال، جهت احراز هویت اجباری API KEY
RecordID آیدی ویدئویی که می‌خواهید آن را حذف کنید. اجباری String

آدرس وب سرویس درخواست حذف ویدیو

https://api.enama.ir/Object/Remove

ساختار Item در بدنه JSON

عنواننوعتوضیحات
{}Statusدر صورتی که عملیات انجام گردد، در بدنه Item، وضعیت True بوده و در صورتی که عملیات انجام نگردد False خواهد بود.

نمونه پاسخ وب سرویس


    {
    "Item":{"Status":true},
    "FilterRequest":{
            "IsHome":0,
            "Keyword":null,
            "ChanelName":null,
            "SortBy":0,
            "ObjectID":0,
            "ObjectNotID":0,
            "Suggestion":0,
            "Relative":0,
            "MyConvertList":0,
            "ChanelID":0,
            "UXD":0,
            "MySubscribe":0,
            "IsMyChannel":0,
            "LastLoadID":0,
            "CategoryID":0,
            "StatusID":0,
            "ServerID":0,
            "OrientationID":0,
            "MonetizeID":0,
            "LicenseID":0,
            "LanguageID":0,
            "TypeFileID":0,
            "HashtagID":0,
            "QualityID":0,
            "PageSize":0,
            "PageIndex":0,
            "Privacy":0,
            "Token":null,
            "MyHistory":0,
            "MyLiked":0,
            "MyWatchLiST":0,
            "ChannelKey":null},
    "IsError":false,
    "Code":1
    }


دریافت لیست کانال ها

این تابع همانند تابع دریافت ویدئوها، دارای صفحه بندی و تعداد آیتم دریافتی در هر صفحه از درخواست است. با استفاده از این تابع لیست تمامی کانال‌های موجود در اینما را می‌توانید دریافت کنید.

نام فیلد توضیحات الزام پارامتر نوع
Token توکن اتصال، جهت احراز هویت اختیاری API KEY
ChanelID این فیلد اختیاری بوده و جهت دریافت یک کانال خاص می‌تواند تکمیل گردد اختیاری String
ChanelName این فیلد اختیاری بوده و جهت دریافت یک کانال خاص به همراه نام، تکمیل می‌گردد اختیاری String
MySubscribe در صورتی که این فیلد را 1 ارسال کنید، لیست تمامی کانال هایی که در آن عضو شده اید را به شما نمایش می‌دهد. در غیر این صورت می‌توانید این مقدار را ارسال نکنید و یا مقدار 1- ارسال کنید اختیاری int
PageSize با تغییر این فیلد می‌توانید در هر درخواست تعداد مشخصی کانال دریافت کنید که به صورت پیشفرض این عدد 20 و در بیشترین حالت این عدد 50 می‌تواند باشد. برای مثال اگر PageSize را 20 قرار دهید، در هر صفحه 20 عدد کانال نمایش داده خواهد شد. اختیاری int
PageIndex با تغییر این فیلد می‌توانید تعداد بیشتری کانال در هر صفحه دریافت کنید. این عدد به صورت پیشفرض از 0 شروع می شود.اگر PageIndex صفر باشد، در صفحه اول، به تعدادی که در PageSizeتعیین کرده‌اید، آخرین کانال‌ها نمایش داده خواهد شد. اختیاری int

آدرس وب سرویس دریافت لیست کانال ها

https://api.enama.ir/Chanel/List

ساختار Item در بدنه JSON

عنواننوعتوضیحات
[]Arrayلیستی از کانال‌ها، در صورتی که کانالی وجود نداشته باشد، null خواهد بود.

نمونه پاسخ وب سرویس


    {
    "Item": [
        {
            "ChanelID": 12013,
            "ChanelUsersID": 1001842,
            "ChanelChanelStatusID": 1,
            "ChanelTitle": "جانم باش",
            "ChanelAbout": "
            ما در منطقه‌های مختلف زندگی نمی‌کنیم، حتی روی کُره‌ی خاکی هم زندگی نمی‌کنیم.
            مکان حقیقی زندگی ما
            قلب کسانی‌ست که
            دوستشان میداریم❤️

            📕 فراتر از بودن
            کریستین بوبن
            ",
            "ChanelUniqueID": "C100184210592020330327",
            "ChanelApproved": 0,
            "ChanelLogo": "NoFile",
            "ChanelCover": "NoFile",
            "ChanelTotalViewed": 897,
            "ChanelTotalSubscribe": 7,
            "ChanelCreateDate": "2020-03-27T10:59:33",
            "ChanelLastAddObject": "2020-06-13T00:10:35",
            "ChanelTotalVideo": 99,
            "ChanelIsPaymentForChannel": false,
            "Chanel1Month": 0,
            "Chanel3Month": 0,
            "Chanel6Month": 0,
            "Chanel12Month": 0,
            "UsersID": 1001842,
            "ChanelStatusID": 1,
            "ChanelStatusLable": "Active"
        }
    ],
    "FilterRequest": {
        "IsHome": -1,
        "Keyword": "",
        "ChanelName": "",
        "SortBy": 1,
        "ObjectID": -1,
        "ObjectNotID": -1,
        "Suggestion": -1,
        "Relative": -1,
        "MyConvertList": -1,
        "ChanelID": -1,
        "UXD": -1,
        "MySubscribe": -1,
        "IsMyChannel": -1,
        "LastLoadID": -1,
        "CategoryID": -1,
        "StatusID": 0,
        "ServerID": 0,
        "OrientationID": -1,
        "MonetizeID": -1,
        "LicenseID": -1,
        "LanguageID": -1,
        "TypeFileID": -1,
        "HashtagID": -1,
        "QualityID": -1,
        "PageSize": 5,
        "PageIndex": 0,
        "Privacy": -1,
        "Token": "",
        "MyHistory": -1,
        "MyLiked": -1,
        "MyWatchLiST": -1,
        "ChannelKey": "NoneChannel"
    },
    "IsError": false,
    "Code": 0
    }

دریافت کانال من

در این درخواست شما می توانید در صورت ثبت نام به کانال های خود دسترسی داشته باشید.

نام فیلد توضیحات الزام پارامتر نوع
Token توکن اتصال، جهت احراز هویت اجباری API KEY
ChanelID این فیلد اختیاری بوده و جهت دریافت یک کانال خاص می‌تواند تکمیل گردد اختیاری String
ChanelName این فیلد اختیاری بوده و جهت دریافت یک کانال خاص به همراه نام، تکمیل می‌گردد اختیاری String
IsMyChannel تکمیل این فیلد اجباری می باشد. در صورتی که در حساب کاربری خود کانال ساخته باشید و این فیلد را 1 ارسال ‌کنید، لیست تمامی کانال‌های شما، نمایش داده خواهد شد. اجباری int
PageSize با تغییر این فیلد می‌توانید در هر درخواست تعداد مشخصی کانال دریافت کنید که به صورت پیشفرض این عدد 20 و در بیشترین حالت این عدد 50 می‌تواند باشد. برای مثال اگر PageSize را 20 قرار دهید، در هر صفحه 20 عدد کانال نمایش داده خواهد شد. اختیاری int
PageIndex با تغییر این فیلد می‌توانید تعداد بیشتری کانال در هر صفحه دریافت کنید. این عدد به صورت پیشفرض از 0 شروع می شود.اگر PageIndex صفر باشد، در صفحه اول، به تعدادی که در PageSizeتعیین کرده‌اید، آخرین کانال‌ها نمایش داده خواهد شد. اختیاری int

آدرس وب سرویس دریافت لیست کانال های من

https://api.enama.ir/Chanel/List

ساختار Item در بدنه JSON

عنواننوعتوضیحات
[]Arrayلیستی از کانال‌ها، در صورتی که کانالی وجود نداشته باشد، null خواهد بود.

نمونه پاسخ وب سرویس


    {
    "Item": [
        {
            "ChanelID": 12345,
            "ChanelUsersID": 123456,
            "ChanelChanelStatusID": 1,
            "ChanelTitle": "enama.ir",
            "ChanelAbout": "Welcome To My Page",
            "ChanelUniqueID": "enama",
            "ChanelApproved": 0,
            "ChanelLogo": "NoFile",
            "ChanelCover": "NoFile",
            "ChanelTotalViewed": 82,
            "ChanelTotalSubscribe": 3,
            "ChanelCreateDate": "2020-03-25T11:26:14",
            "ChanelLastAddObject": "2020-05-06T11:09:42",
            "ChanelTotalVideo": 4,
            "ChanelIsPaymentForChannel": false,
            "Chanel1Month": 0,
            "Chanel3Month": 0,
            "Chanel6Month": 0,
            "Chanel12Month": 0,
            "UsersID": 123456,
            "ChanelStatusID": 1,
            "ChanelStatusLable": "Active",
            "Subscribe": null
        }
    ],
    "FilterRequest": {
        "IsHome": -1,
        "Keyword": "",
        "ChanelName": "",
        "SortBy": -1,
        "ObjectID": -1,
        "ObjectNotID": -1,
        "Suggestion": -1,
        "Relative": -1,
        "MyConvertList": -1,
        "ChanelID": -1,
        "UXD": -1,
        "MySubscribe": -1,
        "IsMyChannel": -1,
        "LastLoadID": -1,
        "CategoryID": -1,
        "StatusID": 0,
        "ServerID": 0,
        "OrientationID": -1,
        "MonetizeID": -1,
        "LicenseID": -1,
        "LanguageID": -1,
        "TypeFileID": -1,
        "HashtagID": -1,
        "QualityID": -1,
        "PageSize": 20,
        "PageIndex": 0,
        "Privacy": -1,
        "Token": "****-****-****-****",
        "MyHistory": -1,
        "MyLiked": -1,
        "MyWatchLiST": -1,
        "ChannelKey": "enama"
    },
    "IsError": false,
    "Code": 0
    }


ویرایش کانال من

در این درخواست شما می توانید کانال یا کانال های خود را ویرایش کنید.

نام فیلد توضیحات الزام پارامتر نوع
Token توکن اتصال، جهت احراز هویت اجباری API KEY
ChanelID آیدی کانالی که می‌خواهید آن را ویرایش نمایید اجباری String
About درصورتی که می‌خواهید این بخش ویرایش گردد، عبارتی بیش از 5 کاراکتر وارد نمایید. اختیاری String
Title درصورتی که می‌خواهید این بخش ویرایش گردد، عبارتی بیش از 5 کاراکتر وارد نمایید. اختیاری String
FileCover برای تغییر کاور کانال ارسال این فایل اجباری است. اختیاری Base64
FileLogo برای تغییر آواتار کانال ارسال این فایل اجباری است. اختیاری Base64

آدرس وب سرویس ویرایش کانال من

https://api.enama.ir/Chanel/edit

ساختار Item در بدنه JSON

عنواننوعتوضیحات
ItemObjectدر صورتی که ویرایش کانال به درستی انجام گردد، null خواهد بود.
Codeintدر صورتی که ویرایش کانال به درستی انجام گردد، مقدار 1 خواهد بود.
IsErrorBooleanدر صورتی که ویرایش کانال به درستی انجام گردد False و در صورتی که بارگذاری با خطا مواجه شود True خواهد بود.

نمونه پاسخ وب سرویس


    {"Item":null,
    "FilterRequest":{
            "IsHome":-1,
            "Keyword":"",
            "ChanelName":"",
            "SortBy":-1,
            "ObjectID":-1,
            "ObjectNotID":-1,
            "Suggestion":-1,
            "Relative":-1,
            "MyConvertList":-1,
            "ChanelID":1,
            "UXD":-1,
            "MySubscribe":-1,
            "IsMyChannel":-1,
            "LastLoadID":-1,
            "CategoryID":-1,
            "StatusID":0,
            "ServerID":0,
            "OrientationID":-1,
            "MonetizeID":-1,
            "LicenseID":-1,
            "LanguageID":-1,
            "TypeFileID":-1,
            "HashtagID":-1,
            "QualityID":-1,
            "PageSize":20,
            "PageIndex":0,
            "Privacy":-1,
            "Token":"****-****-****-****",
            "MyHistory":-1,
            "MyLiked":-1,
            "MyWatchLiST":-1,
            "ChannelKey":"NoneChannel"
    },
    "IsError":false,
    "Code":1
    }


نحوه ساخت کد iFrame

شما می‌توانید به صورت زیر کد iframe ویدئو را بسازید.


<iframe src="https://enama.ir/player/{VideoID}" allowFullScreen="true" 
    scrolling="no" webkitallowfullscreen="true" mozallowfullscreen="true" style="width: 100%; height: 100%">

<iframe><!-- در بخش آدرس ویدیو آیدی مورد نظر خود را وارد کنید -->
 

نحوه ساخت کد script

شما می‌توانید به صورت زیر کد script ویدئو را بسازید.


    <div id="VideoID" datakey="VideoID">
    <script type="text/JavaScript" src="https://api.enama.ir/Object/embeded/{VideoID}">
    </script>
    </div><!-- در کد بالا آیدی های خود را جایگذاری کنید -->
 

ورود یا عضویت با استفاده از شماره ی موبایل

جهت ثبت نام در سایت اینما (eNama) نیاز است مراحل زیر را طی نمایید.

با استفاده از متد زیر شماره موبایل را بررسی نمایید.

ورودی های وب سرویس

نام فیلد توضیحات الزام پارامتر نوع داده
Mobile بررسی می‌کند این شماره‌ی موبایل از قبل در پایگاه داده اینما وجود داشته است یا خیر اجباری String

آدرس وب سرویس بررسی شماره تماس

https://api.enama.ir/Users/isExistMobile

ساختار Item در بدنه JSON

عنواننوعتوضیحات
StatusBooleanدر صورتی که شماره موبایل در اینما وجود داشته باشد این فیلد true خواهد بود و در غیر اینصورت Item در بدنه JSON به صورت null خواهد بود

درصورتی که شماره وجود نداشت شما باید متد ثبت نام را استفاده کنید ودر غیر اینصورت شما متد باید از متد ارسال اس ام اس استفاده کنید

نمونه پاسخ وب سرویس


    {
        "Item": {
            "Status": true,
            "KeyValue": "******"
        },
        "FilterRequest": {
            "IsHome": -1,
            "Keyword": "",
            "ChanelName": "",
            "SortBy": -1,
            "ObjectID": -1,
            "ObjectNotID": -1,
            "Suggestion": -1,
            "Relative": -1,
            "MyConvertList": -1,
            "ChanelID": -1,
            "UXD": -1,
            "MySubscribe": -1,
            "IsMyChannel": -1,
            "LastLoadID": -1,
            "CategoryID": -1,
            "StatusID": 0,
            "ServerID": 0,
            "OrientationID": -1,
            "MonetizeID": -1,
            "LicenseID": -1,
            "LanguageID": -1,
            "TypeFileID": -1,
            "HashtagID": -1,
            "QualityID": -1,
            "PageSize": 20,
            "PageIndex": 0,
            "Privacy": -1,
            "Token": "",
            "MyHistory": -1,
            "MyLiked": -1,
            "MyWatchLiST": -1,
            "ChannelKey": "NoneChannel"
        },
        "IsError": false,
        "Code": 1
    }



ثبت نام کاربر با شماره موبایل

شما برای ثبت نام در سایت اینما می بایست از متد زیر استفاده نمایید

ورودی های وب سرویس

نام فیلد توضیحات الزام پارامتر نوع داده
Mobile شماره تماس برای ثبت نام اجباری String

آدرس وب سرویس ثبت نام

https://api.enama.ir/Users/Register

ساختار Item در بدنه JSON

عنواننوعتوضیحات
ItemObjectدر صورتی که فرآیند ثبت نام کاربر به درستی انجام شود این فیلد Null خواهد بود.
IsErrorBooleanدر صورتی که فرآیند ثبت نام بدون خطا انجام گردد این آیتم False و در صورتی که در طی فرآیند خطایی رخ دهد True خواهد بود.
Codeintدر صورتی که فرآیند ثبت نام بدون خطا و به درستی انجام شود این آیتم 1 خواهد بود.

پس از دریافت جواب یک اس ام اس به شماره تماسی که ارسال شده ارسال خواهد شد و شما باید از متد تایید شماره تماس استفاده نمایید

نمونه پاسخ وب سرویس


        {
        "Item": null,
        "FilterRequest": {
            "IsHome": 0,
            "Keyword": null,
            "ChanelName": null,
            "SortBy": 0,
            "ObjectID": 0,
            "ObjectNotID": 0,
            "Suggestion": 0,
            "Relative": 0,
            "MyConvertList": 0,
            "ChanelID": 0,
            "UXD": 0,
            "MySubscribe": 0,
            "IsMyChannel": 0,
            "LastLoadID": 0,
            "CategoryID": 0,
            "StatusID": 0,
            "ServerID": 0,
            "OrientationID": 0,
            "MonetizeID": 0,
            "LicenseID": 0,
            "LanguageID": 0,
            "TypeFileID": 0,
            "HashtagID": 0,
            "QualityID": 0,
            "PageSize": 0,
            "PageIndex": 0,
            "Privacy": 0,
            "Token": null,
            "MyHistory": 0,
            "MyLiked": 0,
            "MyWatchLiST": 0,
            "ChannelKey": null
        },
        "IsError": false,
        "Code": 1
        }
 

تایید شماره موبایل کاربر

پس از احراز شماره موبایل و ارسال پیامک حاوی کد فعال سازی، می‌بایست از متد زیر برای تایید شماره موبایل استفاده نمایید.

ورودی های وب سرویس

نام فیلد توضیحات الزام پارامتر نوع داده
Mobile شماره تماس برای ثبت نام اجباری String
Code کد ارسالی از سمت وب سرور اجباری int

آدرس وب سرویس تایید شماره تماس

https://api.enama.ir/Users/Verify

ساختار Item در بدنه JSON

در صورتی که کد فعال سازی را به صورت صحیح وارد کنید فیلد Item شامل موارد زیر خوهد بود در غیر اینصورت این آیتم null خواهد بود که باید با توجه به Code ای که در جواب آمده می توانید متوجه خطایی که رخ داده است، شوید.

عنواننوعتوضیحات
UserIDlongآیدی کاربری که در حساب کاربری اینمای خود وارد شده است
ExpireDateDateتاریخ انقضای توکن احراز هویت
StatusIDintدر صورتی که عملیات بدون خطا انجام گردد، وضعیت درخواست به صورت 200 ارسال خواهد شد.
StatusDescStringدرخواست کامل که با Ok ارسال خواهد شد.
TokenAPI KEYتوکن اتصال جهت احراز هویت
Versionintورژن API
FullNameStringنام و نام خانوادگی کامل کاربر
IsPremiumBooleanدر صورتی که کاربری که وارد حساب کاربری اینما شده است، از اعضای ویژه‌ی اینما باشد، این فیلد True خواهد بود.

درصورتی که در خواست شما با خطا مواجه شود Item به صورت null خواهد بود که شما باید از Code موجود در بدنه JSON خطای خود را تشخیص دهید که نوع خطا ها به صورت زیر است

عنوانمقدارتوضیحات
Code2-کد وارد شده معتبر نمی باشد
Code5-محدودیت درخواست در لحظه
Code1درخواست موفقیت آمیز بوده

نمونه پاسخ وب سرویس


    {
        "Item": {
            "UserID": 123456,
            "ExpireDate": "2020-10-27T16:46:52.7826938+04:30",
            "StatusID": 200,
            "StatusDesc": "OK",
            "Token": "****-*****-*****-*****",
            "Version": 1,
            "FullName": "کاربر_ enama",
            "IsPremium": false
        },
        "FilterRequest": {
            "IsHome": 0,
            "Keyword": null,
            "ChanelName": null,
            "SortBy": 0,
            "ObjectID": 0,
            "ObjectNotID": 0,
            "Suggestion": 0,
            "Relative": 0,
            "MyConvertList": 0,
            "ChanelID": 0,
            "UXD": 0,
            "MySubscribe": 0,
            "IsMyChannel": 0,
            "LastLoadID": 0,
            "CategoryID": 0,
            "StatusID": 0,
            "ServerID": 0,
            "OrientationID": 0,
            "MonetizeID": 0,
            "LicenseID": 0,
            "LanguageID": 0,
            "TypeFileID": 0,
            "HashtagID": 0,
            "QualityID": 0,
            "PageSize": 0,
            "PageIndex": 0,
            "Privacy": 0,
            "Token": null,
            "MyHistory": 0,
            "MyLiked": 0,
            "MyWatchLiST": 0,
            "ChannelKey": null
        },
        "IsError": false,
        "Code": 1
    }

ارسال مجدد پیامک حاوی کد تایید

جهت ارسال مجدد کد تایید شماره تماس، می‌بایست از متد زیر استفاده کنید.

ورودی های وب سرویس

نام فیلد توضیحات الزام پارامتر نوع داده
Mobile شماره تماس برای ارسال کد اجباری String

آدرس وب سرویس ارسال مجدد کد

https://api.enama.ir/Users/ResendCode

ساختار JSON خروجی

پس از ارسال شماره تماس Item برابر null خواهد بود که شما باید با استفاده از Code اطلاعات خود را خارج کنید

عنوانمقدارتوضیحات
Code1اس ام اس با موففیت ارسال خواهد شد
Code5-شما قبلا درخواست داده اید

نمونه پاسخ وب سرویس


    {
        "Item": null,
        "FilterRequest": {
            "IsHome": 0,
            "Keyword": null,
            "ChanelName": null,
            "SortBy": 0,
            "ObjectID": 0,
            "ObjectNotID": 0,
            "Suggestion": 0,
            "Relative": 0,
            "MyConvertList": 0,
            "ChanelID": 0,
            "UXD": 0,
            "MySubscribe": 0,
            "IsMyChannel": 0,
            "LastLoadID": 0,
            "CategoryID": 0,
            "StatusID": 0,
            "ServerID": 0,
            "OrientationID": 0,
            "MonetizeID": 0,
            "LicenseID": 0,
            "LanguageID": 0,
            "TypeFileID": 0,
            "HashtagID": 0,
            "QualityID": 0,
            "PageSize": 0,
            "PageIndex": 0,
            "Privacy": 0,
            "Token": null,
            "MyHistory": 0,
            "MyLiked": 0,
            "MyWatchLiST": 0,
            "ChannelKey": null
    },
        "IsError": true,
        "Code": -5
    }

اطلاعات پروفایل

شما برای دریافت اطلاعات پروفایل خود می‌توانید از متد زیر استفاده کنید.

ورودی های وب سرویس

نام فیلد توضیحات الزام پارامتر نوع داده
Token توکن اتصال جهت احراز هویت اجباری API KEY

آدرس وب سرویس اطلاعات پروفایل

https://api.enama.ir/Users/MyInfo

ساختار Item در بدنه JSON

عنواننوعتوضیحات
UsersIDlongآیدی کاربر
UsersNameStringنام کاربر
UsersLastNameStringنام خانوادگی کاربر
UsersMobileStringشماره تماس کاربر
UsersBDateStringتاریخ تولد کاربر
UsersBankAccNumberStringشماره حساب کاربر
UsersBankShebaStringشماره شبای کاربر
UsersBankCardNumberStringشماره کارت بانکی کاربر
UsersNationalCodeStringشناسه ملی کاربر
UsersEmailStringایمیل کاربر

دقت نمایید در صورتی که برای هرکدام از فیلدهای جدول بالا مقداری وجود نداشته باشد، برای آن آیتم مقدار Null باز خواهد گشت.

نمونه پاسخ وب سرویس


    {
    "Item": [
        {
            "UsersID": 123456,
            "UsersName": "کاربر_",
            "UsersLastName": "4930",
            "UsersMobile": "09*********",
            "UsersBDate": "1970-01-01",
            "UsersBankAccNumber": null,
            "UsersBankSheba": null,
            "UsersBankCardNumber": null,
            "UsersNationalCode": "",
            "UsersEmail": null
        }
    ],
    "FilterRequest": {
        "IsHome": 0,
        "Keyword": null,
        "ChanelName": null,
        "SortBy": 0,
        "ObjectID": 0,
        "ObjectNotID": 0,
        "Suggestion": 0,
        "Relative": 0,
        "MyConvertList": 0,
        "ChanelID": 0,
        "UXD": 0,
        "MySubscribe": 0,
        "IsMyChannel": 0,
        "LastLoadID": 0,
        "CategoryID": 0,
        "StatusID": 0,
        "ServerID": 0,
        "OrientationID": 0,
        "MonetizeID": 0,
        "LicenseID": 0,
        "LanguageID": 0,
        "TypeFileID": 0,
        "HashtagID": 0,
        "QualityID": 0,
        "PageSize": 0,
        "PageIndex": 0,
        "Privacy": 0,
        "Token": null,
        "MyHistory": 0,
        "MyLiked": 0,
        "MyWatchLiST": 0,
        "ChannelKey": null
    },
    "IsError": false,
    "Code": 1
    }

ویرایش پروفایل

با استفاده از متد زیر می‌توانید اطلاعات پروفایل خود را ویرایش نمایید.

ورودی های وب سرویس

نام فیلد توضیحات الزام پارامتر نوع داده
Tokenتوکن اتصال جهت احراز هویتاجباریAPI KEY
Nameنام کاربراجباریString
LastNameنام خانوادگی کاربراجباریString
Emailایمیل کاربراختیاریString
NationalCodeکد ملی کاربر جهت امور بانکیاختیاریString
BankAccشماره حساب کاربر جهت امور بانکیاختیاریString
BankCardNumberشماره 16 رقمی کارت بانکی کاربر، جهت امور بانکیاختیاریString
BankShebaشماره 24 رقمی شبای کاربر جهت امور بانکی که می‌بایست بدون IR ارسال شوداختیاریString

آدرس وب سرویس ویرایش پروفایل

https://api.enama.ir/Users/Profile

ساختار Item در بدنه JSON

عنواننوعتوضیحات
UserIDlongآیدی کاربری که وارد شده
ExpireDateDateتاریخ انقضای توکن احراز هویت
StatusIDintدر صورتی که عملیات بدون خطا انجام گردد، مقدار 200 ارسال خواهد شد.
StatusDescStringدر صورتی که عملیات بدون خطا انجام شود، ok ارسال خواهد شد.
TokenAPI KEYتوکن اتصال جهت احراز هویت
Versionintورژن API
FullNameStringنام و نام خانوادگی کامل کاربر
IsPremiumBooleanدر صورتی که کاربر یکی از اعضای ویژه‌ی اینما باشد، این فیلد True و در صورتی که کاربر معمولی باشد false خواهد بود.

دقت نمایید در صورتی که برای هرکدام از فیلدهای جدول بالا مقداری وجود نداشته باشد، برای آن آیتم مقدار Null باز خواهد گشت.

نمونه پاسخ وب سرویس


    {
        "Item": {
            "UserID": 123456,
            "ExpireDate": "2020-10-27T16:46:52.7826938+04:30",
            "StatusID": 200,
            "StatusDesc": "OK",
            "Token": "****-*****-*****-*****",
            "Version": 1,
            "FullName": "ali alavi",
            "IsPremium": false
        },
        "FilterRequest": {
            "IsHome": 0,
            "Keyword": null,
            "ChanelName": null,
            "SortBy": 0,
            "ObjectID": 0,
            "ObjectNotID": 0,
            "Suggestion": 0,
            "Relative": 0,
            "MyConvertList": 0,
            "ChanelID": 0,
            "UXD": 0,
            "MySubscribe": 0,
            "IsMyChannel": 0,
            "LastLoadID": 0,
            "CategoryID": 0,
            "StatusID": 0,
            "ServerID": 0,
            "OrientationID": 0,
            "MonetizeID": 0,
            "LicenseID": 0,
            "LanguageID": 0,
            "TypeFileID": 0,
            "HashtagID": 0,
            "QualityID": 0,
            "PageSize": 0,
            "PageIndex": 0,
            "Privacy": 0,
            "Token": null,
            "MyHistory": 0,
            "MyLiked": 0,
            "MyWatchLiST": 0,
            "ChannelKey": null
        },
        "IsError": false,
        "Code": 1
    }

دریافت اطلاعات داشبورد

جهت دریافت اطلاعات داشبورد خود، می‌بایست از متد زیر استفاده نمایید.

ورودی های وب سرویس

نام فیلد توضیحات الزام پارامتر نوع داده
Token توکن اتصال جهت احراز هویت اجباری API KEY

آدرس وب سرویس اطلاعات داشبورد

https://api.enama.ir/Base/GetReportStatisticsUsers

ساختار Item در بدنه JSON

عنواننوعتوضیحات
TopVideoArrayدر خروجی ویدئوهایی که بیشترین بازدید را داشته‌اند به صورت آرایه ای از Object ها نمایش داده می‌شود.برای هر ویدئو تعداد بازدید ویدئو، آیدی ویدئو و نام ویدئو ارسال می‌گردد.
PublishedVideoArrayخروجی آرایه ای با یک Object است که در آن تعداد کل ویدئوهایی که منتشر کرده‌اید نمایش داده خواهد شد.
InvBenefitArrayخروجی به صورت یک آرایه‌ای است که در آن، میزان درآمد شما حاصل از لینک دعوت به دوستان را نمایش خواهد داد.
ReportVisitArrayبه صورت آرایه ای از Object هاست که در هر کدام آی پی و زمان بازدید را نشان می دهد.
TopComentArrayبه صورت آرایه ای از Object ها است. در هر کدام آخرین نظر ثبت شده‌ی شما به همراه تاریخ، آیدی آن ویدیو و متن نظر کامنت برای شما ارسال می‌شود.
ReportVisitCounterArrayبه صورت آرایه‌ای از یک Object است که میزان بازدید از ویدئوهای شما را به صورت کلی و بر اساس بازدید منحصر به فرد، نشان می دهد.
TopChannelActiveArrayبه صورت آرایه‌ای از Object است که کانال‌های فعال شما را نشان می‌دهد.
UserWalletArrayبه صورت آرایه‌ای از Object است که در آن موجودی ریالی شما را در اینما نشان می‌دهد.
TopUserCashoutStringمیزان درخواست وجه‌های شما را از نمایش می دهد.

نمونه پاسخ وب سرویس



    {
    "Item": {
    "TopVideo": [
        {
            "TotalCount": 1,
            "TotalView": 83,
            "ObjectID": 1390,
            "ObjectTitle": "ارلیگ هالند"
        },
        {
            "TotalCount": 1,
            "TotalView": 65,
            "ObjectID": 1336,
            "ObjectTitle": "منافق"
        },
        {
            "TotalCount": 1,
            "TotalView": 24,
            "ObjectID": 1299,
            "ObjectTitle": "کلیپ خنده دار"
        },
        {
            "TotalCount": 1,
            "TotalView": 24,
            "ObjectID": 1451,
            "ObjectTitle": "فیلمip man4"
        },
        {
            "TotalCount": 1,
            "TotalView": 22,
            "ObjectID": 11680,
            "ObjectTitle": "طبیعت"
        },
        {
            "TotalCount": 1,
            "TotalView": 21,
            "ObjectID": 1433,
            "ObjectTitle": "lennox lwis"
        },
        {
            "TotalCount": 1,
            "TotalView": 21,
            "ObjectID": 1787,
            "ObjectTitle": "حسین وفایی"
        },
        {
            "TotalCount": 1,
            "TotalView": 21,
            "ObjectID": 1452,
            "ObjectTitle": "Tyson"
        },
        {
            "TotalCount": 1,
            "TotalView": 21,
            "ObjectID": 11679,
            "ObjectTitle": "you dont no mee"
        },
        {
            "TotalCount": 1,
            "TotalView": 19,
            "ObjectID": 1394,
            "ObjectTitle": "Tyson تایسون"
        }
    ],
    "PublishedVideo": [
        {
            "TotalVideo": 15
        }
    ],
    "InvBenefit": [
        {}
    ],
    "ReportVisit": [
        {
            "UniqueIP": 1,
            "DateVisit": "2020-06-29",
            "TotalVisit": 1
        },
        {
            "UniqueIP": 2,
            "DateVisit": "2020-06-28",
            "TotalVisit": 2
        },
        {
            "UniqueIP": 4,
            "DateVisit": "2020-06-27",
            "TotalVisit": 7
        },
        {
            "UniqueIP": 2,
            "DateVisit": "2020-06-26",
            "TotalVisit": 3
        },
        {
            "UniqueIP": 2,
            "DateVisit": "2020-06-25",
            "TotalVisit": 2
        },
        {
            "UniqueIP": 2,
            "DateVisit": "2020-06-24",
            "TotalVisit": 2
        },
        {
            "UniqueIP": 1,
            "DateVisit": "2020-06-23",
            "TotalVisit": 1
        },
        {
            "UniqueIP": 4,
            "DateVisit": "2020-06-21",
            "TotalVisit": 4
        },
        {
            "UniqueIP": 1,
            "DateVisit": "2020-06-18",
            "TotalVisit": 1
        },
        {
            "UniqueIP": 2,
            "DateVisit": "2020-06-15",
            "TotalVisit": 2
        }
    ],
    "TopComent": [
        {
            "tblObjectCommnet_ID": 374,
            "tblObjectCommnet_CreateDate": "2020-04-08T10:51:30",
            "tblObjectCommnet_Body": "dsdsdsdsd",
            "tblObjectCommnet__tblObject_ID": 1787
        },
        {
            "tblObjectCommnet_ID": 372,
            "tblObjectCommnet_CreateDate": "2020-04-08T10:50:41",
            "tblObjectCommnet_Body": "sssssss",
            "tblObjectCommnet__tblObject_ID": 1787
        },
        {
            "tblObjectCommnet_ID": 371,
            "tblObjectCommnet_CreateDate": "2020-04-08T10:50:36",
            "tblObjectCommnet_Body": "sssssss",
            "tblObjectCommnet__tblObject_ID": 1787
        },
        {
            "tblObjectCommnet_ID": 245,
            "tblObjectCommnet_CreateDate": "2020-03-16T20:58:05",
            "tblObjectCommnet_Body": "با سلام و احترام شما به این کانال دعوت شدید جهت عضویت از لینک زیر استفاده کنید: https://enama.ir/videos/2821",
            "tblObjectCommnet__tblObject_ID": 1452
        },
        {
            "tblObjectCommnet_ID": 140,
            "tblObjectCommnet_CreateDate": "2020-02-17T10:01:18",
            "tblObjectCommnet_Body": "wwwwww",
            "tblObjectCommnet__tblObject_ID": 1336
        }
    ],
    "ReportVisitCounter": [
        {
            "TotalUniqueView": 339,
            "TotalView": 521
        }
        ],
    "TopChannelActive": null,
    "UserWallet": [
        {
            "tblBalanced_Remining": 65430
        }
    ],
    "TopUserCashout": ""
    },
    "FilterRequest": {
        "IsHome": 0,
        "Keyword": null,
        "ChanelName": null,
        "SortBy": 0,
        "ObjectID": 0,
        "ObjectNotID": 0,
        "Suggestion": 0,
        "Relative": 0,
        "MyConvertList": 0,
        "ChanelID": 0,
        "UXD": 0,
        "MySubscribe": 0,
        "IsMyChannel": 0,
        "LastLoadID": 0,
        "CategoryID": 0,
        "StatusID": 0,
        "ServerID": 0,
        "OrientationID": 0,
        "MonetizeID": 0,
        "LicenseID": 0,
        "LanguageID": 0,
        "TypeFileID": 0,
        "HashtagID": 0,
        "QualityID": 0,
        "PageSize": 0,
        "PageIndex": 0,
        "Privacy": 0,
        "Token": null,
        "MyHistory": 0,
        "MyLiked": 0,
        "MyWatchLiST": 0,
        "ChannelKey": null
    },
    "IsError": true,
    "Code": 0
    }

فاکتور قیمت سرویس ویژه اینما

برای خرید اشتراک سرویس ویژه اینما می‌بایست از متد زیر برای دریافت لیست قیمت اشتراک‌ها استفاده نمایید و با استفاده از آدرس درون آن، سرویس وسژه را خریداری کنید.

ورودی های وب سرویس

نام فیلد توضیحات الزام پارامتر نوع داده
Token توکن اتصال جهت احراز هویت اجباری API KEY
TypeID فیلد اجباری جهت اتصال و باید 2 ارسال شود اجباری int

آدرس وب سرویس فاکتور قیمت های بسته های ویژه

https://api.enama.ir/Upgrade/Users/Factor

ساختار Item در بدنه JSON

عنواننوعتوضیحات
ServiceNameStringنام و مشخصات بسته
OptionPaymentArrayمشخصات بسته به صورت یک Object باز می‌گردد که اطلاعات آن در جدول زیر نمایش داده شده است.

ساختار OptionPayment

عنواننوعتوضیحات
GoURLStringآدرس درگاه پرداخت بسته که در انتهای آن توکن ارسالی شما قرار دارد
TitleStringعنوان بسته
Pricelongقیمت بسته

پس از خرید بسته ویژه اینما فیلد IsPremium در پروفایل شما به صورت true خواهد شد که پس از آن شما به امکانات بیشتری دسترسی خواهید داشت.

نمونه پاسخ وب سرویس


    {
    "Item": {
        "ServiceName": "ارتقال حساب کاربری به بسته نقره ای\r\n",
        "OptionPayment": [
            {
                "GoURL": "http://api.enama.ir/Bank/GoBank.aspx?TokenPayment="توکن شما",>
                "Title": "بسته نقره ای\r\n",
                "Price": 20000000.0
            }
        ]
    },
    "FilterRequest": {
        "IsHome": 0,
        "Keyword": null,
        "ChanelName": null,
        "SortBy": 0,
        "ObjectID": 0,
        "ObjectNotID": 0,
        "Suggestion": 0,
        "Relative": 0,
        "MyConvertList": 0,
        "ChanelID": 0,
        "UXD": 0,
        "MySubscribe": 0,
        "IsMyChannel": 0,
        "LastLoadID": 0,
        "CategoryID": 0,
        "StatusID": 0,
        "ServerID": 0,
        "OrientationID": 0,
        "MonetizeID": 0,
        "LicenseID": 0,
        "LanguageID": 0,
        "TypeFileID": 0,
        "HashtagID": 0,
        "QualityID": 0,
        "PageSize": 0,
        "PageIndex": 0,
        "Privacy": 0,
        "Token": null,
        "MyHistory": 0,
        "MyLiked": 0,
        "MyWatchLiST": 0,
        "ChannelKey": null
    },
    "IsError": false,
    "Code": 1
    }

مشاهده گردش مالی

شما برای دریافت گزارش گردش مالی خود می توانید از اطلاعات زیر استفاده کنید.

نکته مهم درباره این متد این است که شما باید اطلاعات را در قالب متد GET ارسال کنید.

ورودی های وب سرویس

نام فیلد توضیحات الزام پارامتر نوع داده
Token توکن اتصال جهت احراز هویت اجباری API KEY
PageIndex این فیلد برای دریافت گزارش های بیشتر در هر مرحله است که به صورت معمول از 0 شروع می شود و در هر مرحله می توانید به آن یک واحد اضافه کنید و به اطلاعات بیشتری دسترسی داشته باشید. اختیاری int

آدرس وب سرویس فاکتور قیمت های بسته های ویژه

https://api.enama.ir/Balanced/Get

ساختار Item در بدنه JSON

عنواننوعتوضیحات
ItemArrayبه صورت آرایه ای از Object هایی است که در آن هر تراکنش به صورت جداگانه داده شده است و شما می‌توانید در جدول زیر، با فیلد های آن آشنا شوید.

ساختار بدنه Object در آرایه Item

عنواننوعتوضیحات
BalancedIDlongآیدی گردش مالی
BalancedUsersIDlongآیدی کاربری که توکن آن ارسال شده
BalancedBalancedTypeIDintنوع گردش مالی
BalancedPricelongمقدار گردش مالی به ریال
BalancedRemininglongمیزان کیف پول شما پس از گردش مالی
BalancedDetailStringتوضیحات گردش مالی
BalancedDateDateتاریخ گردش مالی
BalancedUniqueIDlongآیدی منحصر به فرد گردش مالی
BalancedServiceTypeIDintنوع سرویسی که از آن در آمد حاصل شده
UsersIDlongآیدی کاربر
BalancedTypeIDlongنوع گردش مالی
BalancedTypeLableStringبرچسب گردش مالی

به طور معمول در هر درخواست 20 آیتم برای شما ارسال می شود که ما در نمونه زیر فقط یک مورد را نمایش می دهیم.

نمونه پاسخ وب سرویس


    {
    "Item": [
        {
            "BalancedID": 38799,
            "BalancedUsersID": 1000425,
            "BalancedBalancedTypeID": 1,
            "BalancedPrice": 100,
            "BalancedRemining": 4490,
            "BalancedDetail": "",
            "BalancedDate": "2020-04-14T14:42:10.76",
            "BalancedUniqueID": 38802,
            "BalancedServiceTypeID": 1,
            "UsersID": 1000425,
            "BalancedTypeID": 1,
            "BalancedTypeLable": "واریز"
        }
    ],
    "FilterRequest": {
        "IsHome": -1,
        "Keyword": "",
        "ChanelName": "",
        "SortBy": -1,
        "ObjectID": -1,
        "ObjectNotID": -1,
        "Suggestion": -1,
        "Relative": -1,
        "MyConvertList": -1,
        "ChanelID": -1,
        "UXD": -1,
        "MySubscribe": -1,
        "IsMyChannel": -1,
        "LastLoadID": -1,
        "CategoryID": -1,
        "StatusID": 0,
        "ServerID": 0,
        "OrientationID": -1,
        "MonetizeID": -1,
        "LicenseID": -1,
        "LanguageID": -1,
        "TypeFileID": -1,
        "HashtagID": -1,
        "QualityID": -1,
        "PageSize": 20,
        "PageIndex": 2,
        "Privacy": -1,
        "Token": "****-****-****-****",
        "MyHistory": -1,
        "MyLiked": -1,
        "MyWatchLiST": -1,
        "ChannelKey": "NoneChannel"
    },
    "IsError": false,
    "Code": 1
    }

درخواست واریز وجه

در صورتی که در آمد شما در سایت اینما بیشتر از 100,000 ریال باشد، امکان درخواست وجه برای شما فعال می‌گردد و می‌توانید درخواست وجه نمایید.

کاربر گرامی باید این نکته را مد نظر داشته باشید که اطلاعات بانکی شما در سایت اینما باید به صورت صحیح وارد شده باشد و وجه از طریق شماره شبا واریز خواهد شد.

ورودی های وب سرویس

نام فیلد توضیحات الزام پارامتر نوع داده
Token توکن اتصال جهت احراز هویت اجباری API KEY
Amount این فیلد میزان درخواست وجه شما است که باید بیشتر از 100,000 و کمتر از 20,000,000 ریال باشد. اجباری int

آدرس وب سرویس درخواست واریز وجه

https://api.enama.ir/Cashout/Add

ساختار JSON خروجی

عنواننوعتوضیحات
StatusBooleanوضعیتی که در بدنه‌ی آیتم باز می‌گردد؛ نشان دهنده‌ی این است که درخواست وجه شما ثبت شده است یا خیر. در صورتی که وضعیت True باشد و Code معادل 1 باشد، یعنی ثبت درخواست به درستی انجام شده است.
Codeintدر صورتی که وضعیت True باشد و Code هر مقداری به غیر از 1 باشد، یعنی ثبت درخواست با خطا مواجه شده است.

ساختار Code در بدنه ی JSON

عنواننوعتوضیحات
Code1درخواست موفقیت آمیز بوده
Code5-شما قبلا درخواست داده اید
Code3- مبلغ درخواستی کمتر از 10,000 ریال است
Code2-اطلاعات بانکی ناقص است

نمونه پاسخ وب سرویس


    {
    "Item": {
        "Status": false,
        "KeyValue": null
    },
    "FilterRequest": {
        "IsHome": 0,
        "Keyword": null,
        "ChanelName": null,
        "SortBy": 0,
        "ObjectID": 0,
        "ObjectNotID": 0,
        "Suggestion": 0,
        "Relative": 0,
        "MyConvertList": 0,
        "ChanelID": 0,
        "UXD": 0,
        "MySubscribe": 0,
        "IsMyChannel": 0,
        "LastLoadID": 0,
        "CategoryID": 0,
        "StatusID": 0,
        "ServerID": 0,
        "OrientationID": 0,
        "MonetizeID": 0,
        "LicenseID": 0,
        "LanguageID": 0,
        "TypeFileID": 0,
        "HashtagID": 0,
        "QualityID": 0,
        "PageSize": 0,
        "PageIndex": 0,
        "Privacy": 0,
        "Token": null,
        "MyHistory": 0,
        "MyLiked": 0,
        "MyWatchLiST": 0,
        "ChannelKey": null
    },
    "IsError": true,
    "Code": -5
    }

ایجاد کانال جدید

چنانچه شما کاربر ویژه‌ی اینما باشید و سرویس پیشرفته‌ی اینما را خریداری کرده باشید؛ امکان ایجاد نهایتا 10 کانال را خواهید داشت.
شما این امکان را خواهید داشت که بر روی کانال مورد نظر، حق عضویت از مخاطبین خود دریافت نمایید.
برای ساخت کانال‌ها می‌بایست از متدهای زیر استفاده نمایید.

ورودی های وب سرویس

نام فیلد توضیحات الزام پارامتر نوع داده
Tokenتوکن اتصال جهت احراز هویتاجباری API KEY
Titleعنوان کانال که می‌بایست بیشتر از 5 کاراکتر باشد.اجباریString
Aboutتوضیحات کانال که می‌بایست بیشتر از 5 کاراکتر باشد.اجباریString
Typeدر صورتی که نوع کانال صفر باشد نشان دهنده این است که این کانال حق عضویتی ندارد و در صورتی که 1 باشد، کانال حق عضویت دارد و باید مقادیر زیر را وارد نمایید.اختیاریint
OneMonthمیزان اشتراک 1 ماههاختیاریString
ThreeMonthمیزان اشتراک 3 ماههاختیاریString
SixMonthمیزان اشتراک 6 ماههاختیاریString
OneYearمیزان اشتراک 1 سالهاختیاریString

آدرس وب سرویس ایجاد کانال

https://api.enama.ir/Chanel/Post

ساختار JSON خروجی

عنواننوعتوضیحات
ItemArrayدر صورتی که کانال با موفقیت ایجاد گردد و مقدار Code معادل 1 باشد، کانال مورد نظر بازگشت داده می‌شود.
Codeintدر صورتی که مقدار 1 باشد وItem خالی نباشد به معنای آن است که عملیات با موفقیت انجام شده و کانال ساخته شده است. در غیر اینصورت عملیات با خطا مواجه شده است.

نمونه پاسخ وب سرویس


    {
    "Item": null,
    "FilterRequest": {
        "IsHome": 0,
        "Keyword": null,
        "ChanelName": null,
        "SortBy": 0,
        "ObjectID": 0,
        "ObjectNotID": 0,
        "Suggestion": 0,
        "Relative": 0,
        "MyConvertList": 0,
        "ChanelID": 0,
        "UXD": 0,
        "MySubscribe": 0,
        "IsMyChannel": 0,
        "LastLoadID": 0,
        "CategoryID": 0,
        "StatusID": 0,
        "ServerID": 0,
        "OrientationID": 0,
        "MonetizeID": 0,
        "LicenseID": 0,
        "LanguageID": 0,
        "TypeFileID": 0,
        "HashtagID": 0,
        "QualityID": 0,
        "PageSize": 0,
        "PageIndex": 0,
        "Privacy": 0,
        "Token": null,
        "MyHistory": 0,
        "MyLiked": 0,
        "MyWatchLiST": 0,
        "ChannelKey": null
    },
    "IsError": true,
    "Code": -5
    }

سفارش تبلیغات

با استفاده از متد زیر می‌توانید در سایت اینما سفارش تبلیغ درج نمایید تا تبلیغات شما در سایت اینما قرار داده شود.

شرایط تبلیغ در اینما به صورت زیر است

  • حداقل سفارش 10,000 پخش می‌باشد
  • طراحی ویدئوی تبلیغات بر عهده سفارش دهنده آگهی خواهد بود.
  • حداقل زمان آگهی 5 ثانیه و حداکثر زمان آگهی تبلیغات 15 ثانیه می‌باشد.
  • محتوای آگهی تبلیغات می‌بایست تابع قوانین جمهوری اسلامی ایران باشد.
  • حداکثر زمان ارسال فایل 7 روز کاری از زمان پرداخت می‌باشد.

ورودی های وب سرویس

نام فیلدتوضیحاتالزام پارامترنوع داده
Tokenتوکن اتصال جهت احراز هویتاجباریAPI KEY
TypeIDدر حال حاضر امکان ثبت سفارش تبلیغ، در ابتدای ویدئو وجود دارد که برای درج سفارش تبلیغ، می‌بایست مقدار 1 را ارسال نمایید.اجباریint
Titleعنوان تبلیغاجباریString
Body توضیحات تبلیغاجباریString
URLلینک مستقیم تبلیغاجباریString
Qtyتعداد پخشاجباری int
Priceهزینه تبلیغ که باید از حاصلضرب تعداد پخش در 700 ریال محاسبه شود.اجباریint

آدرس وب سرویس سفارش تبلیغات

https://api.enama.ir/Ads/Order/New

ساختار Item در بدنه JSON

عنواننوعتوضیحات
ServiceNameStringنام و مشخصات بسته
OptionPaymentArrayمشخصات بسته به صورت یک Object باز می‌گردد که اطلاعات آن در جدول زیر نمایش داده شده است.

ساختار OptionPayment

عنواننوعتوضیحات
GoURLStringآدرس درگاه پرداخت سفارش تبلیغات که در انتهای آن توکن ارسالی شما قرار دارد
TitleStringعنوان تبلیغ
Pricelongقیمت تبلیغ

پس از پرداخت وجه، کارشناسان ما جهت بررسی تبلیغ با شما تماس خواهند گرفت.

نمونه پاسخ وب سرویس


    {
    "Item": {
        "ServiceName": "خرید تبلیغات |  START VIDEO | تعداد پخش : 10,000",
        "OptionPayment": [
            {
                "GoURL": "http://api.enama.ir/Bank/GoBank.aspx?TokenPayment="توکن شما"",
                "Title": "START VIDEO",
                "Price": 7000000
            }
        ]
    },
    "FilterRequest": {
        "IsHome": 0,
        "Keyword": null,
        "ChanelName": null,
        "SortBy": 0,
        "ObjectID": 0,
        "ObjectNotID": 0,
        "Suggestion": 0,
        "Relative": 0,
        "MyConvertList": 0,
        "ChanelID": 0,
        "UXD": 0,
        "MySubscribe": 0,
        "IsMyChannel": 0,
        "LastLoadID": 0,
        "CategoryID": 0,
        "StatusID": 0,
        "ServerID": 0,
        "OrientationID": 0,
        "MonetizeID": 0,
        "LicenseID": 0,
        "LanguageID": 0,
        "TypeFileID": 0,
        "HashtagID": 0,
        "QualityID": 0,
        "PageSize": 0,
        "PageIndex": 0,
        "Privacy": 0,
        "Token": null,
        "MyHistory": 0,
        "MyLiked": 0,
        "MyWatchLiST": 0,
        "ChannelKey": null
    },
    "IsError": false,
    "Code": 1
    }

ایجاد لیست پخش، در کانال اختصاصی

با استفاده از این متد می‌توانید در کانال که ساخته‌اید، لیست پخش یا Playlist ایجاد کرده و محتوای داخل کانال را دسته بندی نمایید.

ورودی های وب سرویس

نام فیلدتوضیحاتالزام پارامترنوع داده
Tokenتوکن اتصال، جهت احراز هویتاجباریAPI KEY
ListNameعنوان لیست پخشاجباریString
ChannelIDشناسه کانالی که لیست پخش در آن ایجاد می‌شوداجباریlong
CoverFileکاور لیست پخش که باید ارسال شوداجباریBase64

آدرس وب سرویس، جهت ایجاد لیست پخش (Playlist)

https://api.enama.ir/PlayList/List/Create

ساختار Item در بدنه JSON

عنواننوعتوضیحات
StatusBooleanدر صورتی که لیست با موفقیت ایجاد گردد، این فیلد True خواهد بود.
KeyValuelongدر این فیلد معمولا یک عدد، باز خواهد گشت که شما نیازی به آن ندارید.

نمونه پاسخ وب سرویس



    {
        "Item": {
            "Status": true,
            "KeyValue": null
        },
        "FilterRequest": {
            "IsHome": 0,
            "Keyword": null,
            "ChanelName": null,
            "SortBy": 0,
            "ObjectID": 0,
            "ObjectNotID": 0,
            "Suggestion": 0,
            "Relative": 0,
            "MyConvertList": 0,
            "ChanelID": 0,
            "UXD": 0,
            "MySubscribe": 0,
            "IsMyChannel": 0,
            "LastLoadID": 0,
            "IsForSale": 0,
            "MyOrder": 0,
            "CategoryID": 0,
            "StatusID": 0,
            "ServerID": 0,
            "OrientationID": 0,
            "MonetizeID": 0,
            "LicenseID": 0,
            "LanguageID": 0,
            "TypeFileID": 0,
            "HashtagID": 0,
            "QualityID": 0,
            "PlayListID": 0,
            "PageSize": 0,
            "PageIndex": 0,
            "Privacy": 0,
            "Token": null,
            "MyHistory": 0,
            "MyLiked": 0,
            "MyWatchLiST": 0,
            "ChannelKey": null
        },
        "IsError": false,
        "Code": 1
    }

حذف لیست پخش، از کانال اختصاصی

با استفاده از این متد می‌توانید لیست پخش (Playlist) ایجاد شده در کانال را حذف کنید؛ اما محتوای آن، داخل کانال باقی بماند.

ورودی های وب سرویس

نام فیلدتوضیحاتالزام پارامترنوع داده
Tokenتوکن اتصال، جهت احراز هویتاجباریAPI KEY
RecordIDشناسه لیست پخش یا PlaylistاجباریLong

آدرس وب سرویس، جهت حذف لیست پخش

https://api.enama.ir/PlayList/List/Remove

ساختار Item در بدنه JSON

عنواننوعتوضیحات
StatusBooleanدر صورتی که لیست با موففیت حذف گردد، این فیلد True خواهد بود
KeyValuelongدر این فیلد معمولا یک عدد بازخواهد گشت که شما به آن نیازی ندارید.

نمونه پاسخ وب سرویس



    {
        "Item": {
            "Status": true,
            "KeyValue": null
        },
        "FilterRequest": {
            "IsHome": 0,
            "Keyword": null,
            "ChanelName": null,
            "SortBy": 0,
            "ObjectID": 0,
            "ObjectNotID": 0,
            "Suggestion": 0,
            "Relative": 0,
            "MyConvertList": 0,
            "ChanelID": 0,
            "UXD": 0,
            "MySubscribe": 0,
            "IsMyChannel": 0,
            "LastLoadID": 0,
            "IsForSale": 0,
            "MyOrder": 0,
            "CategoryID": 0,
            "StatusID": 0,
            "ServerID": 0,
            "OrientationID": 0,
            "MonetizeID": 0,
            "LicenseID": 0,
            "LanguageID": 0,
            "TypeFileID": 0,
            "HashtagID": 0,
            "QualityID": 0,
            "PlayListID": 0,
            "PageSize": 0,
            "PageIndex": 0,
            "Privacy": 0,
            "Token": null,
            "MyHistory": 0,
            "MyLiked": 0,
            "MyWatchLiST": 0,
            "ChannelKey": null
        },
        "IsError": false,
        "Code": 1
    }

ویرایش لیست پخش در کانال اختصاصی

با استفاده از متد زیر شما می‌توانید لیست پخش (Playlist) مورد نظر خود را ویرایش کنید.

ورودی های وب سرویس

نام فیلدتوضیحاتالزام پارامترنوع داده
Tokenتوکن اتصال، جهت احراز هویتاجباریAPI KEY
RecordIDشناسه لیست پخشاجباریLong
ListNameعنوان لیست پخشاجباریاختیاری
ChannelIDشناسه کانالی که می‌خواهید لیست پخش موجود در آن را ویرایش کنید.اجباریlong
CoverFileکاور لیست پخشاختیاریBase64

آدرس وب سرویس ویرایش لیست پخش

https://api.enama.ir/PlayList/List/Edit

ساختار Item در بدنه JSON

عنواننوعتوضیحات
StatusBooleanدر صورتی که ویرایش با موفقیت انجام شود، این فیلد true خواهد بود.
KeyValuelongدر این فیلد معمولا یک عدد بازخواهد گشت که شما به آن نیازی ندارید.

نمونه پاسخ وب سرویس



    {
        "Item": {
            "Status": true,
            "KeyValue": null
        },
        "FilterRequest": {
            "IsHome": 0,
            "Keyword": null,
            "ChanelName": null,
            "SortBy": 0,
            "ObjectID": 0,
            "ObjectNotID": 0,
            "Suggestion": 0,
            "Relative": 0,
            "MyConvertList": 0,
            "ChanelID": 0,
            "UXD": 0,
            "MySubscribe": 0,
            "IsMyChannel": 0,
            "LastLoadID": 0,
            "IsForSale": 0,
            "MyOrder": 0,
            "CategoryID": 0,
            "StatusID": 0,
            "ServerID": 0,
            "OrientationID": 0,
            "MonetizeID": 0,
            "LicenseID": 0,
            "LanguageID": 0,
            "TypeFileID": 0,
            "HashtagID": 0,
            "QualityID": 0,
            "PlayListID": 0,
            "PageSize": 0,
            "PageIndex": 0,
            "Privacy": 0,
            "Token": null,
            "MyHistory": 0,
            "MyLiked": 0,
            "MyWatchLiST": 0,
            "ChannelKey": null
        },
        "IsError": false,
        "Code": 1
    }

مشاهده لیست پخش‌های یک کانال اختصاصی

با استفاده از متد زیر می‌توانید، لیست پخش‌های یک کانال اختصاصی را مشاهده کنید.

ورودی های وب سرویس

نام فیلدتوضیحاتالزام پارامترنوع داده
Tokenتوکن اتصال، جهت احراز هویتاختیاریAPI KEY
ChannelIDشناسه کانال مورد نظراختیاریString

آدرس وب سرویس مشاهده لیست پخش‌های یک کانال اختصاصی

https://api.enama.ir/PlayList/List/InChanel

ساختار Item در بدنه JSON

عنواننوعتوضیحات
PlayListIDLongشناسه لیست پخش
PlayListUsersIDLongشناسه کاربر ایجاد کننده کانال
PlayListtblChanelIDLongشناسه کانالی که لیست پخش در آن قرار دارد
PlayListIsPublicBoolean لیست پخش در دسترس عموم کاربران است یا خیر
PlayListNameStringنام لیست پخش
PlayListTotalViewintتعداد کل بازدید‌های یک لیست پخش، در یک کانال اختصاصی
UsersIDLongشناسه کاریر ایجاد کننده کانال
PlayListArrayآرایه‌ای که تعداد ویدئوهای بارگذاری شده در آن لیست پخش را نمایش می‌دهد.
PlayListItemPlayArrayآرایه ای از یک شی، که شناسه آخرین ویدئو بارگذاری شده در آن لیست پخش را نشان می‌دهد.

ساختار PlayList

عنواننوعتوضیحات
TotalCountLongتعداد ویدئوهای بارگذاری شده در لیست پخش مورد نظر
PlayListIDQLongشناسه لیست پخش

ساختار PlayListItemPlay

عنواننوعتوضیحات
LastObjectIDLongشناسه آخرین ویدئو بارگذاری شده در لیست پخش مورد نظر
PlayListIDQLongشناسه لیست پخش

نمونه پاسخ وب سرویس


{
    "Item": [
        {
            "PlayListID": 23,
            "PlayListUsersID": 1234,
            "PlayListtblChanelID": 12345,
            "PlayListIsPublic": true,
            "PlayListName": "Action",
            "PlayListTotalView": 0,
            "UsersID": 1234,
            "PlayList": [
                {
                    "TotalCount": 1,
                    "PlayListIDQ": 23
                }
            ],
            "PlayListItemPlay": [
                {
                    "LastObjectID": 1451,
                    "PlayListIDQ": 23
                }
            ]
        },
        {
            "PlayListID": 22,
            "PlayListUsersID": 1234,
            "PlayListtblChanelID": 12345,
            "PlayListIsPublic": true,
            "PlayListName": "Animation",
            "PlayListTotalView": 0,
            "UsersID": 1234,
            "PlayList": null,
            "PlayListItemPlay": null
        }
    ],
    "FilterRequest": {
        "IsHome": 0,
        "Keyword": null,
        "ChanelName": null,
        "SortBy": 0,
        "ObjectID": 0,
        "ObjectNotID": 0,
        "Suggestion": 0,
        "Relative": 0,
        "MyConvertList": 0,
        "ChanelID": 0,
        "UXD": 0,
        "MySubscribe": 0,
        "IsMyChannel": 0,
        "LastLoadID": 0,
        "IsForSale": 0,
        "MyOrder": 0,
        "CategoryID": 0,
        "StatusID": 0,
        "ServerID": 0,
        "OrientationID": 0,
        "MonetizeID": 0,
        "LicenseID": 0,
        "LanguageID": 0,
        "TypeFileID": 0,
        "HashtagID": 0,
        "QualityID": 0,
        "PlayListID": 0,
        "PageSize": 0,
        "PageIndex": 0,
        "Privacy": 0,
        "Token": null,
        "MyHistory": 0,
        "MyLiked": 0,
        "MyWatchLiST": 0,
        "ChannelKey": null
    },
    "IsError": true,
    "Code": 0
}

مشاهده لیست ویدئوهای قابل فروش

شما می‌توانید با استفاده از این متد، به لیست تمامی ویدئوهای ارائه شده برای فروش دسترسی داشته و با به اشتراک گذاری لینک یکتای ویدئوها و پیشنهاد آن به دیگران، از فروش هر کدام، کسب درآمد کنید.

ساخت لینک های همکاری در فروش ویدیو

https://enama.ir/GoPayment/AccessVideo/VideoID/UserID
-->UserID شناسه کاربر
-->VideoID شناسه ویدئوی قابل فروش


مشاهده تصاویر مورد نیاز

شما می‌توانید با استفاده از ساختارهای زیر و جایگذاری مقادیر مورد نیاز در هر ساختار، به تصاویر زیر دسترسی داشته باشید.

ساخت لینک، جهت دریافت عکس پروفایل صاحبین کانال‌ها

https://api.enama.ir/Profile/Get/ImageWidth/ImageHeigth/UserID
ImageWidth --> عرض دلخواه
ImageHeigth --> ارتفاع دلخواه
UserID --> شناسه کاربر

ساخت لینک، جهت دریافت تصویر کاور کانال‌های مورد نظر

https://api.enama.ir/Cover/Get/ImageWidth/ImageHeigth/UserID/ChannelID
ImageWidth --> عرض دلخواه
ImageHeigth --> ارتفاع دلخواه
UserID --> شناسه کاربر
ChannelID --> شناسه کانال مورد نظر

ساخت لینک، جهت دریافت تصویر آواتار کانال‌های مورد نظر

https://api.enama.ir/Avatar/Get/ImageWidth/ImageHeigth/UserID/ChannelID
ImageWidth --> عرض دلخواه
ImageHeigth --> ارتفاع دلخواه
UserID --> شناسه کاربر
ChannelID --> شناسه کانال مورد نظر

ساخت لینک، جهت دریافت تصویر کاور ویدئوهای پردازش شده

https://api.enama.ir/Video/Get/ImageWidth/ImageHeigth/ObjectUsersID/id
ImageWidth --> عرض دلخواه
ImageHeigth --> ارتفاع دلخواه
ObjectUsersID --> شناسه کاربر ایجاد کننده ویدئو
id --> شناسه ویدئو مورد نظر