البدء السريع

يأخذك هذا الدليل عبر أسرع مسار من البداية للنهاية:

  1. احصل على مفتاح API من لوحة التحكم
  2. أنشئ قالبًا في المحرر واحفظه في مكتبتك
  3. رنّد صور PNG/JPG عبر إرسال template_id + data + images + options

١) احصل على مفتاح API

أنشئ مفتاح API من لوحة التحكم. تبدأ المفاتيح بـ ak_... وتُمرَّر كـ Bearer token.

Tip

إذا كنت تعمل محليًا بدون إعداد المصادقة، قد تكون نقاط /v1/* مفتوحة. في البيئة الإنتاجية، افترض دائمًا أن جميع النقاط تتطلب مصادقة.

٢) أنشئ قالبًا في المحرر

  1. افتح /app/editor
  2. ارفع صورة الخلفية (PNG/JPG/PDF)
  3. أضف الحقول (حقول نص وصور)
  4. اضغط حفظ

بعد الحفظ، سيظهر لك template_id يمكنك نسخه واستخدامه في الـ API.

٣) رنّد عبر template_id (curl)

حدد الـ URL والمفتاح:

bash
export MIRQAM_BASE_URL="https://api.mirqam.net"
export MIRQAM_API_KEY="ak_live_********"

رنّد:

bash
curl -sS -X POST "$MIRQAM_BASE_URL/v1/render" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $MIRQAM_API_KEY" \
  -d '{"template_id":"<TEMPLATE_ID>","data":{"title":"مرحبًا بكم"},"images":{},"options":{"missing_key_policy":"error","format":"png"}}' \
  --output out.png

٤) رنّد مع حقول الصور

إذا كان المخطط يحتوي على حقل صورة مثل avatar، مرر قيمة base64 في images.avatar:

bash
AVATAR_B64="$(base64 < ./avatar.png | tr -d '\n')"

curl -sS -X POST "$MIRQAM_BASE_URL/v1/render" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $MIRQAM_API_KEY" \
  -d "{\"template_id\":\"<TEMPLATE_ID>\",\"data\":{},\"images\":{\"avatar\":\"${AVATAR_B64}\"},\"options\":{\"missing_key_policy\":\"error\",\"format\":\"png\"}}" \
  --output out.png

أو باستخدام data URL:

bash
curl -sS -X POST "$MIRQAM_BASE_URL/v1/render" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $MIRQAM_API_KEY" \
  -d '{"template_id":"<TEMPLATE_ID>","data":{},"images":{"avatar":"data:image/png;base64,..."},"options":{"missing_key_policy":"error","format":"png"}}' \
  --output out.png
البدء السريع | Mirqam Docs