رنّد الصور
يرنّد مرقم بايتات صور PNG/JPG حقيقية (أو PDF يلفّ المخرج النقطي) من القوالب المحفوظة.
text
https://api.mirqam.net
للتطوير المحلي:
text
http://localhost:8000
شكل الطلب
EndpointPOST/v1/render
أرسل JSON بهذا الشكل:
json
{
"template_id": "<TEMPLATE_ID>",
"data": {
"title": "مرحبًا بكم"
},
"images": {
"avatar": "data:image/png;base64,..."
},
"options": {
"missing_key_policy": "error"
}
}
template_id
string
مطلوب. معرّف القالب المراد رندته.
data
object
أزواج مفتاح/قيمة لحقول النص. المفاتيح تطابق key الحقل في المخطط.
images
object
أزواج مفتاح/قيمة لحقول الصور. القيم base64 أو data URLs.
options
object
خيارات اختيارية للرندر (انظر أدناه).
Note
الرندر المتعدد الأجزاء (multipart) مخصص لتدفقات المعاينة في المحرر، وليس لاستدعاءات الـ API الآلية.
مثال curl
bash
curl -sS -X POST "https://api.mirqam.net/v1/render" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ak_live_********" \
-d '{"template_id":"<TEMPLATE_ID>","data":{"title":"مرحبًا بكم"},"options":{"format":"png"}}' \
--output out.png
مخرج PDF:
bash
curl -sS -X POST "https://api.mirqam.net/v1/render" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ak_live_********" \
-d '{"template_id":"<TEMPLATE_ID>","data":{"title":"مرحبًا بكم"},"options":{"format":"pdf"}}' \
--output out.pdf
حقل data
data كائن JSON مفاتيحه مفاتيح حقول النص.
مثال:
json
{ "title": "ابدأ جلستك اليوم!" }
حقل images
إذا كان المخطط يحتوي على حقول صور، مرر كائن images مفاتيحه مفاتيح حقول الصور.
كل قيمة يمكن أن تكون:
- Base64 خام (
iVBORw0KGgo...) - Data URL (
data:image/jpeg;base64,...)
json
{ "images": { "avatar": "data:image/jpeg;base64,..." } }
options.missing_key_policy
يتحكم في السلوك عند غياب مفتاح حقل من data أو images:
error
افتراضي
يفشل الطلب بـ VALIDATION_ERROR عند غياب أي مفتاح حقل.
empty
string
يتجاوز الحقول المفقودة بصمت دون رسم أي شيء.
default
string
يستخدم القيمة الافتراضية للحقل (حقول النص فقط).
options.format
تنسيق المخرج:
png
افتراضي
صورة PNG.
jpg
string
صورة JPG.
pdf
string
PDF يلفّ الصورة النقطية.