انتقل إلى المحتوى

مكونات القالب

يقدم هذا الدليل معلومات مفصلة حول كيفية التفاعل مع واجهة برمجة التطبيقات (API) الخاصة بنا لإدارة واستخدام أصول الخلفية لقوالبكم.


تحميل أصول الخلفية:

تتيح لك هذه النقطة النهائية تحميل صور أو مقاطع فيديو خلفية لاستخدامها لاحقًا عند إنشاء قوالب لمشاريع إنشاء الفيديو. تذكر ضبط رأس "نوع المحتوى" إلى "multipart/form-data" عند تقديم هذا الطلب.

مثال على طلب: إليك مثال على كيفية تحميل صورة باستخدام curl:

curl --request POST \
     --url 'https://api.immersive-fox.com/v1/template/background_asset_upload/' \
     --header 'X-Api-Key: <your-api-key>' \
     --header 'Content-Type: multipart/form-data' \
     --form 'type=image' \
     --form 'image=@/path/to/your/image.jpg' \
     --form 'thumbnail=@/path/to/your/thumbnail.jpg'
{
    "id": 123,
    "image": "https://url/to/your/image.jpg",
    "thumbnail": "https://url/to/your/thumbnail.jpg"
}

لتحميل فيديو، استخدم type=video وvideo=@/path/to/your/video.mp4. ### ملاحظات - يجب أن يكون حقل type إما "image" أو "video"، حسب نوع المادة التي تُحمّلها. - عند تحميل صورة، يجب عليك أيضًا توفير صورة مصغّرة في حقل thumbnail. - يمكن الرجوع إلى المواد المُحمّلة عند إنشاء قوالب لإنشاء الفيديو. ## قائمة مواد الخلفية: تتيح لك هذه النقطة النهائية إدراج صور ومقاطع فيديو الخلفية التي تم تحميلها كأصول. يمكنك تصفية النتائج بتحديد نوع المادة التي تهمك. تأكد من تضمين مُعامل الاستعلام type في طلبك، والذي يمكن أن يكون إما "image" أو "video". يمكنك أيضًا تحديد "color" لعرض الألوان الافتراضية التي يمكن استخدامها كخلفية. ### مثال على طلب: إليك مثال على كيفية إدراج مواد الخلفية باستخدام curl:

curl --request GET \
     --url 'https://api.immersive-fox.com/v1/template/background_assets/?type=image' \
     --header 'X-Api-Key: <your-api-key>'
[
    {
        "id": 123,
        "image": "https://url/to/your/image.jpg",
        "thumbnail": "https://url/to/your/thumbnail.jpg"
    },
    {
        "id": 124,
        "image": "https://url/to/another/image.jpg",
        "thumbnail": "https://url/to/another/thumbnail.jpg"
    }
]