الانتقال إلى المحتوى الرئيسي
GET
curl

نظرة عامة

يُرجع العلامة التجارية للعلامة البيضاء الخاصة بالتطبيق، ويُحدَّد التطبيق من مفتاح API الخاص بك. وهي نفسها العلامة التجارية التي تظهر للمستخدمين النهائيين في تدفق التحقق. تشمل الاستجابة الألوان والخطوط وأنصاف أقطار الحواف وروابط الشعارات وخيارات واجهة المستخدم وتجربة المستخدم.

متى تستخدمه

  • قراءة السمة الحالية: جلب لوحة الألوان والخط والشعارات النشطة قبل عرضها أو تعديلها.
  • مزامنة العلامة التجارية: نسخ علامة Didit التجارية إلى واجهة الإدارة الخاصة بك.

ملاحظات

  • يُحدَّد التطبيق من مفتاح API، ولا توجد معاملات مسار أو معاملات استعلام.
  • الحقول logo_square وlogo_rectangular وlogo_rectangular_dark وfavicon وfont_url للقراءة فقط. اضبط الشعارات برفع الصور في تحديث العلامة التجارية.
  • logo_rectangular_dark هو الشعار المستطيل للوضع الداكن، ويظهر على خلفية داكنة. تكون قيمته null عندما لا يكون شعار داكن مضبوطًا، أو عندما لا تُعرض الشعارات المستطيلة لحسابك.
  • النطاق المخصص والبريد الإلكتروني بالعلامة البيضاء غير مشمولين في هذه الاستجابة، وتبقى إدارتهما في Business Console.

الأذونات

يجب أن يملك مفتاح API صلاحية قراءة التخصيص للتطبيق.

ذات صلة

التفويضات

x-api-key
string
header
مطلوب

مفتاح API الخاص بتطبيقك، من Developers -> API keys في Business Console. يمتلك المفتاح الأساسي وصولاً كاملاً. يمكن تحديد نطاق المفتاح المسمى: لا شيء، أو قراءة، أو كتابة لكل مورد، ومحدوداً ببعض مسارات العمل أو بالجلسات المقبولة، وبقائمة من عناوين IP، وبتاريخ انتهاء الصلاحية. يشير 401 إلى أن المفتاح غير صحيح أو ملغى أو منتهي الصلاحية؛ ويشير 403 إلى أنه لم يتم إرسال أي مفتاح، أو أن المفتاح ليس لديه حق الوصول إلى هذا المورد أو الإجراء، أو أن الطلب جاء من عنوان خارج قائمة عناوين IP الخاصة به؛ ويشير 404 في مسار جلسة إلى أن الجلسة خارج مسارات العمل أو الحالات الخاصة بالمفتاح. يتلقى المفتاح الذي لا يمتلك حق الوصول إلى الوسائط عناوين URL للصور ومقاطع الفيديو وملفات PDF كـ null، ويتلقى المفتاح الذي لا يمتلك إذن كتابة للجلسات روابط الجلسة وtoken كـ null. راجع https://docs.didit.me/console/api-keys.

الاستجابة

تخصيص الهوية البصرية الحالي للتطبيق.

العلامة التجارية ذات العلامة البيضاء لتطبيق ما: الألوان والخطوط وأنصاف الأقطار وروابط الشعار وخيارات UI/UX. روابط الشعار للقراءة فقط (عيّنها عن طريق تحميل الصور). النطاق المخصص والبريد الإلكتروني للعلامة البيضاء غير مشمولين.

color_primary
string
color_secondary
string
color_background
string
color_panel
string
color_panel_10
string
color_on_panel_1
string
color_on_panel_2
string
color_on_background
string
color_button_1
string
color_button_2
string
color_button_text_1
string
color_button_text_2
string
color_pill_text
string
border_radius_panel
integer
border_radius_buttons
integer
font_family
string
font_weight
string
font_url
string | null

للقراءة فقط. رابط ورقة أنماط Google Fonts التي تم حلها لمجموعة الخطوط المحددة.

logo_square
string | null

رابط للقراءة فقط للشعار المربع. يتم الرفع عبر image_square.

logo_rectangular
string | null

رابط للقراءة فقط للشعار المستطيل. يتم الرفع عبر image_rectangular.

logo_rectangular_dark
string<uri> | null

للقراءة فقط. رابط موقّع مؤقت للشعار المستطيل للوضع الداكن، يُعرض على خلفية داكنة. null عند عدم تعيين شعار داكن أو إذا كانت الشعارات المستطيلة لا تُعرض لحسابك. ارفعه باستخدام image_rectangular_dark.

favicon
string | null

رابط للقراءة فقط للأيقونة المفضلة (favicon). يتم الرفع عبر image_favicon.

app_public_name
string | null
privacy_policy_url
string | null
skip_welcome_screen
boolean
disable_login_with_didit
boolean
hide_progress_bar
boolean
callback_seconds
integer
آخر تعديل في ٧ نوفمبر ٢٠٢٦