در چند دقیقه متصل شوید
شناسه و رمز برنامه را از کلید اختصاصی پنل بردارید، توکن کوتاهمدت دریافت کنید و با همان توکن به مسیرهای نسخهٔ ۲ درخواست بفرستید.
مسیر اتصال
شناسه و رمز برنامه
مقدار کامل کلید تنها یک بار هنگام ساخت نمایش داده میشود؛ آن را در محیط امن سرور ذخیره کنید. شناسهٔ برنامه همان ۱۶ نویسهٔ نخست کلید است و در فهرست کلیدهای پنل بهصورت پیشوند دیده میشود. نمونه: برای کلید فرضی vck_ABCDEFGHIJK...، مقدار client_id برابر vck_ABCDEFGHIJK است. کلید کامل، client_secret خواهد بود.
v2 از مسیر /api/v2 و توکن موقت استفاده میکند. کلید ثابت را مستقیم در درخواستهای v2 نفرستید. مسیرهای قبلی /api/v1/video-uploads برای اتصالهای موجود باقی میمانند.
دریافت توکن ۱۵ دقیقهای
این درخواست باید از سرور برنامه و با HTTPS ارسال شود. دامنههای خواندن و نوشتن را فقط بهاندازهٔ نیاز برنامه درخواست کنید. مقدار پیشفرض بدون scope برابر groups.read video.read video.upload است؛ برای مدیریت گروه، ویدیو، لایو یا زیرنویس دامنههای متناظر را صریحاً اضافه کنید.
curl -X POST 'https://videoclick.ir/api/v2/oauth/token' \ -H 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'grant_type=client_credentials' \ --data-urlencode 'client_id=vck_ABCDEFGHIJK' \ --data-urlencode 'client_secret=vck_YOUR_FULL_KEY' \ --data-urlencode 'scope=groups.read groups.write video.read video.upload video.write video.import live.read live.write subtitle.read subtitle.write'
200 OK
{"access_token":"vct_...","token_type":"Bearer",
"expires_in":900,"scope":"groups.read video.read video.upload live.write subtitle.write"}توکن را در حافظهٔ امن سرور نگه دارید؛ قبل از پایان ۹۰۰ ثانیه، با همین درخواست توکن تازه بگیرید. لغو کلید در پنل، توکنهای صادرشده از آن را نیز بیاثر میکند.
محدودههای دسترسی
| Scope | کاربرد |
|---|---|
groups.read / groups.write | خواندن / ساخت و ویرایش و حذف گروهها |
video.read / video.upload / video.write / video.import | خواندن، بارگذاری، ویرایش و حذف، افزودن از آدرس |
live.read / live.write | فهرست و جزئیات / ساخت و تنظیم و حذف رویداد |
subtitle.read / subtitle.write | فهرست زبانها و فایلها / بارگذاری و ساخت و ویرایش و حذف |
آزمون اتصال بدون ساخت ویدیو
curl 'https://videoclick.ir/api/v2/capabilities' \ -H 'Authorization: Bearer vct_YOUR_ACCESS_TOKEN'
curl 'https://videoclick.ir/api/v2/groups' \ -H 'Authorization: Bearer vct_YOUR_ACCESS_TOKEN'
پاسخ قابلیتها apiVersion: "v2"، اندازهٔ قطعه، سقف فایل، تعداد نشستهای باز و batchEnabled را نشان میدهد.
خطاها و امنیت
- کلید و توکن را در مرورگر، اپ موبایل، نشانی URL یا مخزن عمومی قرار ندهید؛ این اتصال برای سرور برنامه است.
- ۴۰۰ در مسیر توکن میتواند نشاندهندهٔ
invalid_scopeیاunsupported_grant_typeباشد. ۴۰۱ یعنی اطلاعات برنامه یا توکن معتبر نیست؛ برای توکن منقضی، توکن تازه بگیرید. - ۴۰۳ با
insufficient_scopeیعنی دامنهٔ توکن برای عملیات کافی نیست. ۴۰۳ باplan_deniedیعنی مجوز پلن یا اشتراک حساب فعال نیست. - اگر پاسخ ۴۲۹ با
Retry-Afterرسید، پیش از تکرار صبر کنید. تعداد توکنهای فعال برای هر کلید محدود است.