راهنمای وب سرویس ساخت ویدیو

معرفی وب سرویس مای تیزر

این وب‌سرویس به وب‌سایت شما امکان می‌دهد تا از طریق API اختصاصی، درخواست ساخت ویدیو برای کاربران خود ارسال کنید. پس از ثبت درخواست، فرآیند ساخت ویدیو در سرور ما آغاز شده و در صورت نیاز، لینک نهایی و وضعیت ساخت به وب‌سایت درخواست‌دهنده اطلاع داده می‌شود. این سرویس مناسب کسب‌وکارهایی است که می‌خواهند تجربه شخصی‌سازی ویدیو و ارائه ویدیوهای منحصر به کاربران خود را فراهم کنند.

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

برای استفاده از وب سرویس مای تیزر، ابتدا مدیر یا رابط وب‌سایت شما باید در سامانه ما ثبت‌نام کرده و پروفایل کاربری خود را تکمیل کند. پس از خرید اشتراک و انتخاب قالب‌های ویدیویی، باید با پشتیبانی مای تیزر تماس گرفته و یک شناسه یکتا دریافت کنید. ازین پس برای استفاده از وب سرویس، ارائه‌ی این شناسه در هر درخواست الزامی است.

ارسال درخواست ساخت ویدیو

پس از دریافت شناسه یکتا، وب‌سایت شما می‌تواند با ارسال اطلاعات لازم، درخواست ساخت ویدیو را ثبت کند. برای این منظور لازم است پارامترهای موجود در جدول زیر را، با توجه به نوع داده‌ها و نام فیلد، با متد POST به آدرس مشخص شده ارسال نمایید.

POST https://api.myteaser.ir/api/remote/video-generate

Headers: 
	Accept: application/json
	Content-Type: application/json

نام	نوع	الزام	توضیحات
`business_id`	`string`	✅	شناسه یکتای دریافتی
`template_id`	`string`	✅	شناسه قالب ویدیویی؛ از طریق پنل کاربری قابل دستیابی است.
`customer_mobile`	`string`	❌	موبایل مشتری شما؛ در صورت ارسال این فیلد، لینک ویدیوی نهایی توسط مای تیزر برای مشتری شما پیامک می‌گردد.
`callback_url`	`string`	❌	لینک برگشتی به وبسایت شما؛ در صورت ارسال این فیلد، اتمام فرآیند ساخت ویدیو از طریق این لینک به شما اعلام می‌گردد.
`frameX`	`string`	✅	محتوای مورد نظر برای درج در ویدیو؛ نوع و جزئیات فریم(ها) از طریق فرم پایین همین صفحه قابل دستیابی است.

توجه: جهت مشاهده جزئیات فریم(های) قالب های ویدیویی خود، پس از دریافت شناسه یکتا، به فرم پایین همین صفحه مراجعه کنید.

نمونه درخواست ارسالی :

{
    "business_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "template_id": "1",
    "customer_mobile": "0912...",
    "callback_url": "https://yoursite.com/video-status",
    "frame17": "YOUR TEXT"
}

در پاسخ شما یک کد پیگیری ویدیو (video_refid) دریافت می‌کنید، که لازم است این کد را سمت خود نگهداری و ذخیره کنید تا بتوانید وضعیت ساخت ویدیو را از طریق آن پیگیری کنید.

نمونه پاسخ دریافتی :

{
    "result": true,
    "message": "درخواست ساخت ویدیو ثبت شد.",
    "video_refid": "KyEAGRBOvOlZsKRS"
}

اعلام اتمام ساخت ویدیو

پس از پایان فرآیند ساخت ویدیو در مای تیزر، سامانه ما به‌صورت خودکار لینک callback ارسال‌شده را با شناسه پیگیری ویدیو فراخوانی می‌کند. لازم به ذکر است، از آنجایی که فیلد callback_url در مرحله قبلی اختیاری بود، این فراخوانی فقط در صورت تمایل شما و در صورتی که این لینک را در درخواست خود ارسال کرده باشید، اجرا می‌گردد. این فراخوانی به وب‌سایت شما اطلاع می‌دهد که ویدیو آماده شده و می‌توانید وضعیت آن را بررسی کنید.

GET https://yoursite.com/video-status?video_refid=KyEAGRBOvOlZsKRS

پیگیری وضعیت ساخت ویدیو

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

POST https://api.myteaser.ir/api/remote/video-status

Headers: 
	Accept: application/json
	Content-Type: application/json

نام	نوع	الزام	توضیحات
`business_id`	`string`	✅	شناسه یکتای دریافتی
`video_refid`	`string`	✅	شناسه پیگیری ویدیو؛ دریافت شده از مرحله قبل

نمونه درخواست ارسالی :

{
    "business_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "video_refid": "KyEAGRBOvOlZsKRS"
}

نمونه پاسخ دریافتی :

{
    "result": true,
    "status": "completed",
    "progress": 100,
    "final_video_link": "https://myteaser.ir/urvf/abcd.mp4"
}

راهنمایی و پشتیبانی وب سرویس

در صورت نیاز به راهنمایی بیشتر یا بروز هرگونه پرسش در خصوص استفاده از وب‌سرویس، تیم پشتیبانی ما همواره آماده پاسخگویی و همراهی با شماست. لطفاً از طریق راه‌های ارتباطی درج‌شده در صفحه تماس با ما با ما در ارتباط باشید تا در کوتاه‌ترین زمان ممکن پاسخگوی نیازهای شما باشیم.

جزئیات درخواست برای قالب های ویدیویی شما

پس از دریافت شناسه یکتا، لطفا آن را در کادر زیر وارد کرده و ارسال کنید تا جزئیات درخواست ساخت ویدیو، برای هر قالب شما نمایش داده شود.

منوی اصلی

جستجو