واجهة برمجة القوالب

تخصيص المظهر المرئي لنماذجك من خلال خصائص قالب دقيقة.

تتيح لك واجهة برمجة القوالب قراءة وتحديث القالب المرئي الكامل للنموذج. تتحكم خصائص القالب في الألوان والخطوط والعلامة التجارية والتخطيط لكل من النموذج نفسه وعناصر واجهة المستخدم الفردية مثل الأزرار والمؤشرات والخيارات.

تستخدم جميع هياكل الطلب والاستجابة أسماء حقول بتنسيق snake_case.

Endpoints

GET/api/v1/forms/:id/themePUT/api/v1/forms/:id/theme

الحصول على قالب النموذج

GET/api/v1/forms/:id/theme

يسترجع جميع خصائص القالب لنموذج.

معاملات المسار

idstring

معرّف النموذج

الاستجابة

json

{
  "theme_color": "#6366f1",
  "background_color": "#0a0a0a",
  "text_color": "#ffffff",
  "answer_text_color": "#e5e7eb",
  "placeholder_color": "#6b7280",
  "button_color": "#6366f1",
  "button_text_color": "#ffffff",
  "title_color": "#f9fafb",
  "description_color": "#d1d5db",
  "option_text_color": "#e5e7eb",
  "indicator_bg_color": "#1f2937",
  "indicator_text_color": "#9ca3af",
  "font_family": "Inter",
  "font_family_answer": "Inter",
  "font_family_button": "Inter",
  "font_family_description": "Inter",
  "font_family_option": "Inter",
  "font_family_indicator": "Inter",
  "question_font_size": "24px",
  "custom_css": null,
  "show_progress_bar": true,
  "branding_logo_url": null,
  "branding_footer_text": null,
  "hide_branding": false,
  "top_logo_url": null,
  "top_logo_size": null,
  "top_logo_alignment": "center",
  "top_logo_css": null,
  "watermark_css": null,
  "welcome_title": "Welcome",
  "welcome_description": null,
  "welcome_button_text": "Start",
  "thank_you_title": "Thank you!",
  "thank_you_description": null
}

أمثلة على الكود

bash

curl -X GET "https://api.nueform.io/api/v1/forms/665a1b2c3d4e5f6a7b8c9d0e/theme" \
  -H "Authorization: Bearer YOUR_API_KEY"

تحديث قالب النموذج

PUT/api/v1/forms/:id/theme

يُحدّث خصائص القالب لنموذج. قم بتضمين الحقول التي تريد تغييرها فقط. تحتفظ الحقول غير المحددة بقيمها الحالية.

معاملات المسار

idstring

معرّف النموذج

هيكل الطلب

قم بتضمين أي مجموعة من خصائص القالب من مرجع خصائص القالب أدناه.

مثال على الطلب

json

{
  "theme_color": "#2563eb",
  "background_color": "#ffffff",
  "text_color": "#111827",
  "button_color": "#2563eb",
  "button_text_color": "#ffffff",
  "font_family": "Poppins",
  "question_font_size": "28px",
  "show_progress_bar": true,
  "hide_branding": true,
  "top_logo_url": "https://cdn.example.com/logo.svg",
  "top_logo_size": "140px",
  "top_logo_alignment": "left"
}

الاستجابة

يُرجع كائن القالب الكامل المُحدَّث (نفس مخطط الحصول على قالب النموذج).

أمثلة على الكود

bash

curl -X PUT "https://api.nueform.io/api/v1/forms/665a1b2c3d4e5f6a7b8c9d0e/theme" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "theme_color": "#2563eb",
    "background_color": "#ffffff",
    "text_color": "#111827",
    "font_family": "Poppins"
  }'

مرجع خصائص القالب

فيما يلي القائمة الكاملة لخصائص القالب المتاحة للتخصيص.

خصائص الألوان

theme_colorstring

اللون الرئيسي المميز المستخدم في جميع أنحاء النموذج (حلقات التركيز، التمييز). الافتراضي: "#6366f1"

background_colorstring

لون خلفية النموذج. الافتراضي: "#0a0a0a"

text_colorstring

لون نص السؤال الرئيسي. الافتراضي: null

answer_text_colorstring

لون النص المكتوب في حقول الإجابة. الافتراضي: null

placeholder_colorstring

لون النص التوضيحي في الحقول الفارغة. الافتراضي: null

button_colorstring

لون خلفية أزرار الإرسال/التالي. الافتراضي: null

button_text_colorstring

لون نص أزرار الإرسال/التالي. الافتراضي: null

title_colorstring

لون نص عنوان السؤال (يتجاوز text_color للعناوين). الافتراضي: null

description_colorstring

لون نص وصف السؤال. الافتراضي: null

option_text_colorstring

لون نص خيارات الاختيار المتعدد والقوائم المنسدلة. الافتراضي: null

indicator_bg_colorstring

لون خلفية مؤشر رقم الخطوة/السؤال. الافتراضي: null

indicator_text_colorstring

لون نص مؤشر رقم الخطوة/السؤال. الافتراضي: null

خصائص الخطوط

font_familystring

عائلة الخط لعناوين الأسئلة. يدعم أي خط من Google Fonts أو خط نظام. الافتراضي: null

font_family_answerstring

عائلة الخط لنص الإجابة. الافتراضي: null

font_family_buttonstring

عائلة الخط لنصوص الأزرار. الافتراضي: null

font_family_descriptionstring

عائلة الخط لأوصاف الأسئلة. الافتراضي: null

font_family_optionstring

عائلة الخط لنصوص خيارات الاختيار المتعدد. الافتراضي: null

font_family_indicatorstring

عائلة الخط لمؤشرات رقم الخطوة/السؤال. الافتراضي: null

question_font_sizestring

حجم خط عناوين الأسئلة (مثل: "24px" أو "1.5rem"). الافتراضي: null

التخطيط وشريط التقدم

show_progress_barboolean

ما إذا كان يتم عرض شريط تقدم في أعلى النموذج. الافتراضي: true

العلامة التجارية

branding_logo_urlstring

رابط شعار العلامة التجارية المعروض في منطقة التذييل. الافتراضي: null

branding_footer_textstring

نص مخصص يُعرض في تذييل النموذج. الافتراضي: null

hide_brandingboolean

إخفاء تذييل علامة NueForm التجارية الافتراضية. الافتراضي: false

top_logo_urlstring

رابط الشعار المعروض في أعلى النموذج. الافتراضي: null

top_logo_sizestring

حجم الشعار العلوي (مثل: "120px" أو "80px"). الافتراضي: null

top_logo_alignmentstring

المحاذاة الأفقية للشعار العلوي: "left" أو "center" أو "right". الافتراضي: null

top_logo_cssstring

CSS مخصص يُطبَّق على حاوية الشعار العلوي. الافتراضي: null

watermark_cssstring

CSS مخصص يُطبَّق على العلامة المائية للعلامة التجارية. الافتراضي: null

شاشات الترحيب والشكر

welcome_titlestring

نص العنوان المعروض على شاشة الترحيب. الافتراضي: null

welcome_descriptionstring

نص الوصف على شاشة الترحيب. الافتراضي: null

welcome_button_textstring

نص الزر على شاشة الترحيب. الافتراضي: "Start"

thank_you_titlestring

نص العنوان على شاشة الإكمال. الافتراضي: "Thank you!"

thank_you_descriptionstring

نص الوصف على شاشة الإكمال. الافتراضي: null

متقدم

custom_cssstring

CSS عشوائي يُحقن في عارض النموذج. استخدمه للتخصيصات المتقدمة التي لا تغطيها خصائص القالب. الافتراضي: null

استجابات الأخطاء

استجابات الأخطاء القياسية التي تُرجعها نقاط النهاية هذه.

رموز الأخطاء

401Unauthorized

مفتاح API مفقود أو غير صالح

403Forbidden

صلاحيات غير كافية لنماذج الفريق

404Not Found

النموذج غير موجود

500Server Error

خطأ داخلي في الخادم

مثال على خطأ

json

{
  "error": "Form not found"
}

آخر تحديث: 6 أبريل 2026