ابدأ الآن
التكامل / SDKs
التحقق من المستخدمين
التحقق من الشركات
مراقبة المعاملات
سجل التغييراتتحديث تخصيص العلامة البيضاء عبر Management API
حدّث العلامة البيضاء في Didit عبر Management API: غيّر الألوان والخطوط وأنصاف أقطار الحواف، وارفع الشعارات، واضبط خيارات واجهة التحقق.
نظرة عامة
يُجري تحديثًا جزئيًا للعلامة البيضاء الخاصة بالتطبيق المحدَّد من مفتاح API الخاص بك. أرسلapplication/json لتغيير الألوان والخطوط ونصف أقطار الزوايا وخيارات الواجهة، أو multipart/form-data لرفع الشعارات. تُغيَّر الحقول التي تُضمّنها فقط، وتبقى بقية الحقول دون تعديل.
متى تستخدمه
- تخصيص التدفق: حدّد ألوان علامتك التجارية وخطها ونصف أقطار زواياها.
- رفع الشعارات: حدّد الشعار المربّع، والشعار المستطيل ونسخته للوضع الداكن، والأيقونة المصغّرة (favicon).
- ضبط التجربة: حدّد اسم التطبيق العام، ورابط سياسة الخصوصية، وخيارات التبديل مثل تخطّي شاشة الترحيب أو إخفاء شريط التقدم.
رفع الشعارات
أرسل الشعارات بصيغةmultipart/form-data:
image_square: نسبة العرض إلى الارتفاع 1:1.image_rectangular: نسبة العرض إلى الارتفاع 2:1.image_rectangular_dark: نسبة العرض إلى الارتفاع 2:1. الشعار المستطيل للوضع الداكن، ويُعرض على خلفية داكنة.image_favicon: الحد الأقصى 500 KB.
image_square وimage_rectangular وimage_rectangular_dark صورًا بصيغة PNG أو JPG أو WebP، بطول لا يقل عن 512 بكسل للضلع الأطول، وبحجم لا يتجاوز 1 MB.
تُرفض ملفات SVG.
تُعيد الاستجابة عناوين URL الناتجة للحقول logo_square وlogo_rectangular وlogo_rectangular_dark وfavicon.
لحذف شعار، أرسل علامة الحذف المطابقة delete_logo_square أو delete_logo_rectangular أو delete_logo_rectangular_dark أو delete_favicon بالقيمة true.
بعد حذف شعار الوضع الداكن، يعيد الحقل logo_rectangular_dark القيمة null.
إذا تضمّن الطلب الواحد رفعًا لشعار وأرسل علامة حذفه أيضًا، فالرفع هو الذي يُنفَّذ.
يعيد رفعٌ مرفوض الاستجابة 400 مع اسم الحقل وسبب الرفض، مثل:
{"image_rectangular_dark": ["Upload a PNG, JPG or WebP image."]}{"image_rectangular": ["Image must be at least 512 px on its long side. Got 400x200 image dimensions"]}{"image_rectangular": ["Image aspect ratio must be 2:1. Got 1024x1024 image dimensions"]}{"image_square": ["File size should not exceed 1 MB"]}
ملاحظات
- يُحدَّد التطبيق من مفتاح API، ولا توجد معاملات مسار.
- تقبل الألوان السداسية عشرية الصيغة
#RRGGBBأو#RRGGBBAA. يجب أن يكونfont_weightوزنًا متاحًا للخطfont_familyالمحدد. - لا يمكن ضبط النطاق المخصص وبريد العلامة البيضاء الإلكتروني من هنا. أدِرهما في Business Console.
الأذونات
يجب أن يملك مفتاح API الإذن بتحديث التخصيص للتطبيق.ذات صلة
التفويضات
مفتاح API الخاص بتطبيقك، من Developers -> API keys في Business Console. يمتلك المفتاح الأساسي وصولاً كاملاً. يمكن تحديد نطاق المفتاح المسمى: لا شيء، أو قراءة، أو كتابة لكل مورد، ومحدوداً ببعض مسارات العمل أو بالجلسات المقبولة، وبقائمة من عناوين IP، وبتاريخ انتهاء الصلاحية. يشير 401 إلى أن المفتاح غير صحيح أو ملغى أو منتهي الصلاحية؛ ويشير 403 إلى أنه لم يتم إرسال أي مفتاح، أو أن المفتاح ليس لديه حق الوصول إلى هذا المورد أو الإجراء، أو أن الطلب جاء من عنوان خارج قائمة عناوين IP الخاصة به؛ ويشير 404 في مسار جلسة إلى أن الجلسة خارج مسارات العمل أو الحالات الخاصة بالمفتاح. يتلقى المفتاح الذي لا يمتلك حق الوصول إلى الوسائط عناوين URL للصور ومقاطع الفيديو وملفات PDF كـ null، ويتلقى المفتاح الذي لا يمتلك إذن كتابة للجلسات روابط الجلسة وtoken كـ null. راجع https://docs.didit.me/console/api-keys.
الجسم
نص التحديث الجزئي للعلامة التجارية. قدّم الحقول التي تريد تغييرها فقط. تقبل الألوان السداسية عشرية التنسيق #RRGGBB أو #RRGGBBAA. لا يُقبل النطاق المخصص والبريد الإلكتروني بالعلامة البيضاء هنا.
لون العناوين / النص الأساسي.
لون الفقرة / النص الثانوي.
لون خلفية الصفحة.
لون اللوحة / التمييز.
لون اللوحة بنسبة عتامة 10%.
لون النص المساعد في اللوحات.
لون الشارة / العلامة على اللوحات.
لون النص على الخلفية.
لون الزر الأساسي.
لون الزر الثانوي.
لون نص الزر الأساسي.
لون نص الزر الثانوي.
لون النص للشارات وحقول الإدخال ومحددات الخيارات.
نصف قطر زاوية اللوحة بالبكسل.
x >= 0نصف قطر زاوية الزر بالبكسل.
x >= 0اسم عائلة خط Google (مثل Inter، AR One Sans).
وزن الخط المتاح للعائلة المحددة (مثل regular، 500، 700).
الاسم العام المعروض في مسار التحقق.
رابط سياسة الخصوصية المعروض للمستخدم النهائي.
تخطي شاشة الترحيب الأولية.
المتابعة كضيف بدلاً من عرض شاشة تسجيل الدخول عبر Didit. لا يمكن إعادته إلى false أثناء تكوين نطاق مخصص (400).
إخفاء شريط التقدم أثناء سير العمل.
التأخير (بالثواني) قبل إعادة التوجيه إلى رابط الاستدعاء.
x >= 0عندما تكون true، يُزال الشعار المربع الحالي.
عندما تكون true، يُزال الشعار المستطيل الحالي.
عندما تكون true، يُزال شعار الوضع الداكن الحالي، وتصبح قيمة logo_rectangular_dark حينها null. إذا قام نفس طلب multipart أيضاً برفع image_rectangular_dark، فستكون الأولوية لعملية الرفع.
عندما تكون true، تتم إزالة أيقونة الموقع (favicon) الحالية.
الاستجابة
تم تحديث الهوية البصرية. يتم إرجاع كائن الهوية البصرية كاملاً (جميع الحقول، وليس فقط الحقول التي قمت بتغييرها).
العلامة التجارية ذات العلامة البيضاء لتطبيق ما: الألوان والخطوط وأنصاف الأقطار وروابط الشعار وخيارات UI/UX. روابط الشعار للقراءة فقط (عيّنها عن طريق تحميل الصور). النطاق المخصص والبريد الإلكتروني للعلامة البيضاء غير مشمولين.
للقراءة فقط. رابط ورقة أنماط Google Fonts التي تم حلها لمجموعة الخطوط المحددة.
رابط للقراءة فقط للشعار المربع. يتم الرفع عبر image_square.
رابط للقراءة فقط للشعار المستطيل. يتم الرفع عبر image_rectangular.
للقراءة فقط. رابط موقّع مؤقت للشعار المستطيل للوضع الداكن، يُعرض على خلفية داكنة. null عند عدم تعيين شعار داكن أو إذا كانت الشعارات المستطيلة لا تُعرض لحسابك. ارفعه باستخدام image_rectangular_dark.
رابط للقراءة فقط للأيقونة المفضلة (favicon). يتم الرفع عبر image_favicon.