استفاده از متدها
آدرس و نحوه استفاده از متدها و پارامترها
https://www.aparat.com//etc/api/[Method Name]/[Variable 1]/[Value 1]/[Variable 2]/[Value 2]/...
خروجی
- خروجی متدها آرایه ای JSON می باشد.
- اولین خانه آرایه خروجی با اندیس نام متد خروجی اصلی متد را دربر دارد.
- در خروجی متدهایی که احتیاج به صفحه بندی دارند یک ردیف جدید با نام ui اضافه می شوذ که شامل دو خانه با نام های [pagingForward] و [pagingBack] می باشد که آدرس صفحه بعد و قبل در آنها می باشد.
- نمونه خروجی:
https://www.aparat.com//etc/api/mostviewedvideos
Array ( [mostviewedvideos] => Array ( [0] => Array ( [id] => 1144319 [title] => کلیپس (شوخی کردم) [username] => mostafa2mim [visit_cnt] => 30196 [uid] => 8FOTS [sender_name] => 2MIM [big_poster] => http://www.aparat.com/public/public/user_data/video_thumb/229/1144319_1_b.jpg?532 [small_poster] => http://www.aparat.com/public/public/user_data/video_thumb/229/1144319_1.jpg [profilePhoto] => http://www.aparat.com/public/public/user_data/profile_photo/94/279586-s.jpg?389 [duration] => 63 [sdate] => ۶ اردیبهشت ۱۳۹۳ ) ) [ui] => Array ( [pagingForward] => '' [pagingBack] => '' ) )
انواع نمایش داده ها - RESPONSE
کانال
اطلاعات کانال
اطلاعات یک کاربر
نام فیلد | نوع فیلد | توضیحات |
---|---|---|
pic_s | url | آدرس عکس اندازه کوچک |
pic_m | url | آدرس عکس اندازه متوسط |
pic_b | url | آدرس عکس اندازه بزرگ |
username | string | نام کاربری کاربر |
name | string | نام کاربر |
video_cnt | int | تعداد ویدیو های کاربر |
url | url | آدرس سایت کاربر |
follower_cnt | int | تعداد دنبال کننده های کاربر |
followed_cnt | int | تعداد دنبال کرده های کاربر |
descr | string | توضیحات کانال |
official | string | صفحه رسمی هست یا نه |
cloob | url | آدرس صفحه سایت کلوب |
lenzor | url | آدرس صفحه لنزور کانال |
url | آدرس صفحه فیسبوک | |
url | آدرس صفحه توییتر | |
follow_link | url | لینک دنبال کردن یا نکردن صفحه |
follow_status | string | وضعیت دنبال کردن یا نکردن صفحه |
cover_src | url | آدرس کاور صفحه کانال |
profile_videos | string |
صفحه یک کانال
اطلاعات یک کاربر
نام فیلد | نوع فیلد | توضیحات |
---|---|---|
cat_id | int | آیدی طبقه بندی |
cat_name | string | نام طبقه بندی |
cat_cnt | int | تعداد ویدیوهای این طبقه بندی |
link | url | آدرس این طبقه بندی |
data | array | آرایه ای از ویدیو ها می باشد که هر سطرش مثل دادههای لیست ویدیو است |
ویدیو
اطلاعات یک ویدیو
اطلاعات یک ویدیو
نام فیلد | نوع فیلد | توضیحات |
---|---|---|
id | int | آیدی ویدیو |
title | string | عنوان ویدیو |
username | string | نام کاربری فرستنده ویدیو |
userid | int | آیدی فرستنده ویدیو |
visit_cnt | int | تعداد بازدیدهای ویدیو |
uid | string | uid یکتای ویدیو |
process | string | وضعیت ویدیو |
sender_name | string | نام فرستنده ویدیو |
big_poster | url | لینک پوستر ویدیو سایز بزرگ |
small_poster | url | لینک پوستر ویدیو سایز کوچک |
profilePhoto | url | لینک عکس فرستنده ویدیو |
duration | int | مدت زمان ویدیو به ثانیه |
sdate | string | تاریخ ارسال ویدیو |
frame | url | لینک frame ویدیو |
official | string | رسمی یا نبودن کانال |
tags | list | لیستی از تگ ها |
description | string | توضیحات ویدیو |
cat_id | int | آیدی طبقه بندی سایت ویدیو |
cat_name | string | نام طبقه بندی ویدیو |
autoplay | boolean | اتوپلی ویدیو هست یا نه |
360d | boolean | ویدیو 360 درجه هست یا نه |
has_comment | string | امکان نظر گذاشتن ویدیو |
has_comment_txt | string | متن گذاشتن نظر برای ویدیو |
size | int | حجم ویدیو |
watch_action | array | دارای دو فیلد می باشد که type وضعیت فیلم را نشان می دهد که اگر watch باشد امکان دیدن ویدیو را دارید |
cost_type | array | |
can_download | boolean | امکان دانلود ویدیو وجود دارد یا خیر |
like_cnt | int | تعدا افرادی که این ویدیو رو پسندید |
لیست ویدیو
لیستی از ویدیو ها که هر سطر آن این اطلاعات را بر میگرداند
نام فیلد | نوع فیلد | توضیحات |
---|---|---|
id | int | آیدی ویدیو |
title | string | عنوان ویدیو |
username | string | نام کاربری فرستنده ویدیو |
userid | int | آیدی فرستنده ویدیو |
visit_cnt | int | تعداد بازدیدهای ویدیو |
uid | string | uid یکتای ویدیو |
process | string | وضعیت ویدیو |
big_poster | url | آدرس پوستر سایز بزرگ ویدیو |
small_poster | url | آدرس پوستر سایز کوچک ویدیو |
duration | int | مدت زمان ویدیو با ثانیه |
sdate | string | تاریخ ارسال ویدیو |
frame | url | frame ویدیو |
official | string | رسمی بودن یا نبودن |
autoplay | boolean | اتو پلی بودن ویدیو |
360d | boolean | ویدیو 360 درجه بودن |
پروفایل
اطلاعات پروفایل
اطلاعات پروفایل بعد از لاگین
نام فیلد | نوع فیلد | توضیحات |
---|---|---|
id | int | آیدی کاربر |
username | string | username کاربر |
name | string | نام کاربر |
pic | string | عکس پروفایل داره یا خیر |
ltoken | string | توکن برای کارهایی که نیاز به لاگین دارد مثل آپلود ویدیو و ... |
banned | string | کاربر مسدود شده یا نه که با yes یا no مشخص میشود |
string | ایمیل کاربر | |
mobile_number | string | شماره موبایل کاربر |
mobile_valid | url | شماره موبایلی که توسط کاربر تأیید شده است |
pic_s | url | لینک عکس پروفایل سایز کوچک |
pic_m | url | لینک عکس پروفایل سایز متوسط |
pic_b | url | لینک عکس پروفایل سایزبزرگ |
فرم ها
فرم اکشن
برای گرفتن formAction و ارسال اطلاعات استفاده میشود
نام فیلد | نوع فیلد | توضیحات |
---|---|---|
formAction | url | اطلاعاتی که میخواهید از طریق POST ارسال نمایید به این آدرس بفرستید |
frm-id | int | آیدی فرم |
متدهای مجاز
متدهای پروفایل
login
برای لاگین کاربر
نام پارامتر | نوع پارامتر | الزام پارامتر | توضیحات پارامتر |
---|---|---|---|
luser | string | اجباری | نام کاربری |
lpass | string | اجباری | sha1(MD5(password)) |
نمونه لینک | https://www.aparat.com/etc/api/login/luser/test/lpass/345rfdvfg4fsfdvsfsdcer |
---|
همان خروجی دادههای اطلاعات پروفایل است
profile
با این متد می توانید اطلاعات یک کاربر رو بدست آورید
نام پارامتر | نوع پارامتر | الزام پارامتر | توضیحات پارامتر |
---|---|---|---|
username | string | اجباری | نام کاربری (username) |
نمونه لینک | https://www.aparat.com/etc/api/profile/username/alooty |
---|
خروجی این متد همان خروجی های پروفایل است
userBySearch
جستجوی کاربر
نام پارامتر | نوع پارامتر | الزام پارامتر | توضیحات پارامتر |
---|---|---|---|
text | string | اجباری | متن مورد جستجو باید بالای 3حرف و بصورت url_encode فرستاده شود |
perpage | int | اختیاری | تعداد ویدیوها در صفحه |
نمونه لینک | https://www.aparat.com/etc/api/userBySearch/text/perspolis/perpage/10 |
---|
خروجی این متد همان دادههای کانال است
profilecategories
طبقه بندی های کاربر
نام پارامتر | نوع پارامتر | الزام پارامتر | توضیحات پارامتر |
---|---|---|---|
username | string | اجباری | نام کاربری صفحه کاربر |
نمونه لینک | https://www.aparat.com/etc/api/profilecategories/username/test |
---|
لیست طبقه بندی های کانال
متدهای ویدیو
video
اطلاعات یک ویدیو
نام پارامتر | نوع پارامتر | الزام پارامتر | توضیحات پارامتر |
---|---|---|---|
videohash | string | اجباری | uid ویدیو مورد نظر |
نمونه لینک | https://www.aparat.com/etc/api/video/videohash/rzKus |
---|
خروجی این متد همان دادههای ویدیو است
categoryVideos
ویدیوهای یک طبقه بندی
نام پارامتر | نوع پارامتر | الزام پارامتر | توضیحات پارامتر |
---|---|---|---|
perpage | int | اختیاری | تعداد ویدیوها در صفحه |
cat | int | اختیاری | آیدی طبقه بندی مورد نظر اگر پارامتری تعیین نکنید بطور پیشفرض همه ویدیوهای از طبقه بندی مختلف رو نشان میدهد |
نمونه لینک | https://www.aparat.com/etc/api/categoryVideos/cat/7/perpage/10 |
---|
خروجی این متد همان دادههای لیست ویدیو است و ویدیوهای طبقه بندی مورد نظر را برمیگرداند
videoByUser
ویدیو های یک کاربر
نام پارامتر | نوع پارامتر | الزام پارامتر | توضیحات پارامتر |
---|---|---|---|
username | string | اجباری | نام کاربری |
perpage | int | اختیاری | تعداد ویدیوها در صفحه |
نمونه لینک | https://www.aparat.com/etc/api/videoByUser/username/alooty/perpage/10 |
---|
خروجی این متد همان دادههای لیست ویدیو است
commentByVideos
نظرات یک ویدیو
نام پارامتر | نوع پارامتر | الزام پارامتر | توضیحات پارامتر |
---|---|---|---|
videohash | string | اجباری | uid ویدیو مورد نظر |
perpage | int | اختیاری | تعداد ویدیوها در صفحه |
نمونه لینک | https://www.aparat.com/etc/api/commentByVideos/videohash/sGNgD/perpage/10 |
---|
خروجی این متد همان دادههای لیست کامنت ها است
videoBySearch
جستجوی ویدیو
نام پارامتر | نوع پارامتر | الزام پارامتر | توضیحات پارامتر |
---|---|---|---|
text | string | اجباری | متن مورد جستجو باید بالای 3حرف و بصورت url_encode فرستاده شود |
perpage | int | اختیاری | تعداد ویدیوها در صفحه |
نمونه لینک | https://www.aparat.com/etc/api/videoBySearch/text/perspolis/perpage/10 |
---|
خروجی این متد همان دادههای لیست ویدیو است
videobytag
لیست ویدیوهای تگ مورد نظر
نام پارامتر | نوع پارامتر | الزام پارامتر | توضیحات پارامتر |
---|---|---|---|
text | string | اجباری | نام تگ |
نمونه لینک | https://www.aparat.com/etc/api/videobytag/text/جشنوار |
---|
uploadform
فرم اکشن برای آپلود ویدیو
نام پارامتر | نوع پارامتر | الزام پارامتر | توضیحات پارامتر |
---|---|---|---|
luser | string | اجباری | نام کاربری فرستنده نظر |
ltoken | string | اجباری | توکن دریافتی از لاگین |
نمونه لینک | https://www.aparat.com/etc/api/uploadform/luser/test/ltoken/sadsdwe3e123edeaasdasda |
---|
خروجی این متد همان دادههای فرم اکشن است
uploadpost
post data برای ارسال آپلود ویدیو
نام پارامتر | نوع پارامتر | الزام پارامتر | توضیحات پارامتر |
---|---|---|---|
video | file | اجباری | فایل ویدیو برای آپلود |
frm-id | int | اجباری | که در مرحله uploadform از سرور گرفته شده است |
data[title] | string | اجباری | عنوان ویدیو |
data[category] | int | اجباری | آیدی طبقه بندی پروفایل ویدیو را از اینجا می توانید بدست بیاورید |
data[tags] | string | اختیاری | تگ های ویدیو که با - از هم جدا میشوند |
data[comment] | string | اختیاری | (yes or no) بازبودن یا نبودن کامنت گذاری برای ویدیو |
data[descr] | string | اختیاری | توضیحات ویدیو |
data[video_pass] | boolean | اختیاری | وضعیت انتشار ویدیو در سایت است . اگر مقدار true ارسال شود وضعیت ویدیو در سایت به حالت عدم انتشار درمی آید و فقط صاحب ویدیو میتواند ویدیو رو تماشا کند. |
در صورت موفق بودن آپلود ، سرور مقدار uid را بر می گرداند.
deletevideolink
حذف ویدیو
نام پارامتر | نوع پارامتر | الزام پارامتر | توضیحات پارامتر |
---|---|---|---|
luser | string | اجباری | نام کاربری |
ltoken | string | اجباری | توکن دریافتی کاربر در مرحله لاگین |
videohash | string | اجباری | uid ویدیویی که میخواهید حذف شود |
نمونه لینک | https://www.aparat.com/etc/api/deletevideolink/videohash/[uid]/luser/test/ltoken/wiejqkeweeduq78udai9ds98 |
---|
برای حذف ویدیو فراخوانی نموده و از لینک خروجی این متد برای حذف ویدئو استفاده نمایید .
متدهای لایو
init[GET]
ایجاد پخش زنده جدید
نام پارامتر | نوع پارامتر | الزام پارامتر | توضیحات پارامتر |
---|---|---|---|
luser | string | اجباری | نام کاربری فرستنده |
ltoken | string | اجباری | نام کاربری فرستنده |
نمونه لینک | http://api.aparat.com/fa/v1/live/live/init/luser/afshin/ltoken/[ltoken] |
---|
خروجی این متد همان دادههای خروجی پخش زنده جدید است
list[GET]
لیست پخش زنده
نمونه لینک | http://api.aparat.com/fa/v1/live/live/list |
---|
خروجی این متد همان دادههای خروجی لیست پخش زنده است
checkbitrate[POST]
لیست پخش زنده
نام پارامتر | نوع پارامتر | الزام پارامتر | توضیحات پارامتر |
---|---|---|---|
file | file | اجباری | نام ورودی فایل |
نمونه لینک | http://api.aparat.com/fa/v1/live/live/checkbitrate |
---|
خروجی این متد همان دادههای خروجی بیت ریت است
update_title[GET]
ویرایش عنوان پخش زنده
نام پارامتر | نوع پارامتر | الزام پارامتر | توضیحات پارامتر |
---|---|---|---|
luser | string | اجباری | نام کاربری فرستنده |
ltoken | string | اجباری | نام کاربری فرستنده |
title | string | اجباری | عنوان |
نمونه لینک | http://api.aparat.com/fa/v1/live/live/update_title |
---|
خروجی این متد همان دادههای خروجی است
changestatus[GET]
ویرایش عنوان پخش زنده
نام پارامتر | نوع پارامتر | الزام پارامتر | توضیحات پارامتر |
---|---|---|---|
connection_status | string | اجباری | وضعیت کانکشن |
name | string | اجباری | کد پخش زنده |
نمونه لینک | http://api.aparat.com/fa/v1/live/live/changestatus |
---|
خروجی این متد همان دادههای خروجی است
غیره
categories
طبقه بندی های سایت آپارات
نمونه لینک | https://www.aparat.com/etc/api/categories |
---|
videoByProfileCat
ویدیو های یک طبقه از طبقه بندیهای کاربر
نام پارامتر | نوع پارامتر | الزام پارامتر | توضیحات پارامتر |
---|---|---|---|
username | string | اجباری | نام کاربری صفحه کاربر |
usercat | int | اجباری | آیدی طبقه بندی کابر مورد نظر |
perpage | int | اجباری | تعداد ویدیوها هر صفحه |
luser | string | اختیاری | نام کاربری |
ltoken | string | اختیاری | token کاربر |
نمونه لینک | https://www.aparat.com/etc/api/videobyprofilecat/usercat/21280/username/tabaar |
---|
همان خروجی دادههای لیست ویدیو است