curl -X GET 'https://verification.didit.me/v3/customization/' \
-H 'x-api-key: YOUR_API_KEY'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.customization.retrieve()
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.customization.retrieve();
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Customization.Retrieve(ctx)
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.customization().retrieve();
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->customization->retrieve();
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.customization.retrieve
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Customization.RetrieveAsync();
Console.WriteLine(JsonSerializer.Serialize(result));{
"color_primary": "#000000",
"color_secondary": "#9DA1A1",
"color_background": "#FFFFFF",
"color_panel": "#2567FF",
"color_panel_10": "#1A1A1A",
"color_on_panel_1": "#9DA1A1",
"color_on_panel_2": "#F4F4F6",
"color_on_background": "#000000",
"color_button_1": "#2567FF",
"color_button_2": "#F8F8F8",
"color_button_text_1": "#FFFFFF",
"color_button_text_2": "#000000",
"color_pill_text": "#111827",
"border_radius_panel": 10,
"border_radius_buttons": 12,
"font_family": "Inter",
"font_weight": "regular",
"font_url": "https://fonts.googleapis.com/css2?family=Inter",
"logo_square": null,
"logo_rectangular": null,
"logo_rectangular_dark": null,
"favicon": null,
"app_public_name": "Acme Verify",
"privacy_policy_url": "https://acme.com/privacy",
"skip_welcome_screen": false,
"disable_login_with_didit": false,
"hide_progress_bar": false,
"callback_seconds": 3
}{
"detail": "You do not have permission to perform this action."
}واجهة الحصول على تخصيص العلامة البيضاء API
اقرأ إعدادات العلامة البيضاء لتطبيقك عبر Didit Management API: الألوان والخطوط ونصف أقطار الحواف وروابط الشعارات وخيارات واجهة التحقق.
curl -X GET 'https://verification.didit.me/v3/customization/' \
-H 'x-api-key: YOUR_API_KEY'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.customization.retrieve()
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.customization.retrieve();
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Customization.Retrieve(ctx)
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.customization().retrieve();
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->customization->retrieve();
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.customization.retrieve
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Customization.RetrieveAsync();
Console.WriteLine(JsonSerializer.Serialize(result));{
"color_primary": "#000000",
"color_secondary": "#9DA1A1",
"color_background": "#FFFFFF",
"color_panel": "#2567FF",
"color_panel_10": "#1A1A1A",
"color_on_panel_1": "#9DA1A1",
"color_on_panel_2": "#F4F4F6",
"color_on_background": "#000000",
"color_button_1": "#2567FF",
"color_button_2": "#F8F8F8",
"color_button_text_1": "#FFFFFF",
"color_button_text_2": "#000000",
"color_pill_text": "#111827",
"border_radius_panel": 10,
"border_radius_buttons": 12,
"font_family": "Inter",
"font_weight": "regular",
"font_url": "https://fonts.googleapis.com/css2?family=Inter",
"logo_square": null,
"logo_rectangular": null,
"logo_rectangular_dark": null,
"favicon": null,
"app_public_name": "Acme Verify",
"privacy_policy_url": "https://acme.com/privacy",
"skip_welcome_screen": false,
"disable_login_with_didit": false,
"hide_progress_bar": false,
"callback_seconds": 3
}{
"detail": "You do not have permission to perform this action."
}نظرة عامة
يُرجع العلامة التجارية للعلامة البيضاء الخاصة بالتطبيق، ويُحدَّد التطبيق من مفتاح API الخاص بك. وهي نفسها العلامة التجارية التي تظهر للمستخدمين النهائيين في تدفق التحقق. تشمل الاستجابة الألوان والخطوط وأنصاف أقطار الحواف وروابط الشعارات وخيارات واجهة المستخدم وتجربة المستخدم.متى تستخدمه
- قراءة السمة الحالية: جلب لوحة الألوان والخط والشعارات النشطة قبل عرضها أو تعديلها.
- مزامنة العلامة التجارية: نسخ علامة Didit التجارية إلى واجهة الإدارة الخاصة بك.
ملاحظات
- يُحدَّد التطبيق من مفتاح API، ولا توجد معاملات مسار أو معاملات استعلام.
- الحقول
logo_squareوlogo_rectangularوlogo_rectangular_darkوfaviconوfont_urlللقراءة فقط. اضبط الشعارات برفع الصور في تحديث العلامة التجارية. logo_rectangular_darkهو الشعار المستطيل للوضع الداكن، ويظهر على خلفية داكنة. تكون قيمتهnullعندما لا يكون شعار داكن مضبوطًا، أو عندما لا تُعرض الشعارات المستطيلة لحسابك.- النطاق المخصص والبريد الإلكتروني بالعلامة البيضاء غير مشمولين في هذه الاستجابة، وتبقى إدارتهما في 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.
الاستجابة
تخصيص الهوية البصرية الحالي للتطبيق.
العلامة التجارية ذات العلامة البيضاء لتطبيق ما: الألوان والخطوط وأنصاف الأقطار وروابط الشعار وخيارات UI/UX. روابط الشعار للقراءة فقط (عيّنها عن طريق تحميل الصور). النطاق المخصص والبريد الإلكتروني للعلامة البيضاء غير مشمولين.
للقراءة فقط. رابط ورقة أنماط Google Fonts التي تم حلها لمجموعة الخطوط المحددة.
رابط للقراءة فقط للشعار المربع. يتم الرفع عبر image_square.
رابط للقراءة فقط للشعار المستطيل. يتم الرفع عبر image_rectangular.
للقراءة فقط. رابط موقّع مؤقت للشعار المستطيل للوضع الداكن، يُعرض على خلفية داكنة. null عند عدم تعيين شعار داكن أو إذا كانت الشعارات المستطيلة لا تُعرض لحسابك. ارفعه باستخدام image_rectangular_dark.
رابط للقراءة فقط للأيقونة المفضلة (favicon). يتم الرفع عبر image_favicon.