शुरू करें
इंटीग्रेट करें / SDK
उपयोगकर्ता सत्यापन
व्यवसाय सत्यापन
लेन-देन निगरानी
चेंजलॉगब्रांडिंग कस्टमाइज़ेशन अपडेट API
Didit के Management API से व्हाइट लेबल ब्रांडिंग अपडेट करें: रंग, फ़ॉन्ट और बॉर्डर रेडियस बदलें, लोगो अपलोड करें और सत्यापन फ़्लो UI विकल्प सेट करें।
अवलोकन
आपकी API कुंजी से पहचाने गए एप्लिकेशन की व्हाइट लेबल ब्रांडिंग को आंशिक रूप से अपडेट करता है। रंग, फ़ॉन्ट, कोनों का रेडियस और UI विकल्प बदलने के लिएapplication/json भेजें, या लोगो अपलोड करने के लिए multipart/form-data भेजें। केवल वही फ़ील्ड बदले जाते हैं जो आप शामिल करते हैं। बाकी सब जैसा है वैसा ही रहता है।
इसे कब उपयोग करें
- फ़्लो की थीम तय करें: अपने ब्रांड के रंग, फ़ॉन्ट और कोनों का रेडियस सेट करें।
- लोगो अपलोड करें: वर्गाकार लोगो, आयताकार लोगो और उसका डार्क मोड संस्करण, तथा फ़ेविकॉन सेट करें।
- अनुभव को अनुकूलित करें: सार्वजनिक एप्लिकेशन नाम, गोपनीयता नीति URL सेट करें, और वेलकम स्क्रीन छोड़ने या प्रगति बार छिपाने जैसे टॉगल सेट करें।
लोगो अपलोड करना
लोगो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 px हो और आकार अधिकतम 1 MB हो।
SVG फ़ाइलें अस्वीकार की जाती हैं।
रिस्पॉन्स में परिणामी logo_square, logo_rectangular, logo_rectangular_dark और favicon URL लौटाता है।
लोगो हटाने के लिए, मिलते-जुलते 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 कुंजी, Business Console में Developers -> API keys से। प्राथमिक कुंजी के पास पूर्ण एक्सेस होता है। एक नामित कुंजी को स्कोप किया जा सकता है: प्रति संसाधन none, read या write, कुछ वर्कफ़्लो या स्वीकृत सत्रों तक सीमित, IP पतों की सूची तक सीमित, और समाप्ति तिथि तक सीमित। 401 का अर्थ है कि कुंजी गलत है, निरस्त कर दी गई है या उसकी समय-सीमा समाप्त हो गई है; 403 का अर्थ है कि कोई कुंजी नहीं भेजी गई थी, कुंजी के पास इस संसाधन या कार्रवाई का एक्सेस नहीं है, या अनुरोध उसकी IP सूची से बाहर के पते से आया था; सत्र रूट पर 404 का अर्थ है कि सत्र कुंजी के वर्कफ़्लो या स्थितियों से बाहर है। मीडिया एक्सेस के बिना एक कुंजी को छवि, वीडियो और PDF URL null के रूप में प्राप्त होते हैं, और सत्र write के बिना एक कुंजी को सत्र लिंक और token null के रूप में प्राप्त होते हैं। देखें https://docs.didit.me/console/api-keys।
बॉडी
आंशिक ब्रांडिंग अपडेट बॉडी। केवल वे फ़ील्ड प्रदान करें जिन्हें आप बदलना चाहते हैं। हेक्स रंग #RRGGBB या #RRGGBBAA स्वीकार करते हैं। कस्टम डोमेन और व्हाइट लेबल ईमेल यहाँ स्वीकार नहीं किए जाते हैं।
हेडर / प्राथमिक टेक्स्ट का रंग।
पैराग्राफ / द्वितीयक टेक्स्ट रंग।
पेज की पृष्ठभूमि का रंग।
पैनल / एक्सेंट रंग।
10% अपारदर्शिता पर पैनल रंग।
पैनल पर सहायक टेक्स्ट का रंग।
पैनलों पर पिल / बैज का रंग।
बैकग्राउंड पर टेक्स्ट का रंग।
प्राथमिक बटन का रंग।
द्वितीयक बटन का रंग।
प्राथमिक बटन टेक्स्ट का रंग।
द्वितीयक बटन के टेक्स्ट का रंग।
पिल्स, इनपुट और चयनकर्ताओं के लिए टेक्स्ट का रंग।
पिक्सेल में पैनल कॉर्नर रेडियस।
x >= 0पिक्सल में बटन कॉर्नर रेडियस।
x >= 0Google फ़ॉन्ट फ़ैमिली का नाम (उदा. Inter, AR One Sans)।
चयनित फ़ैमिली के लिए उपलब्ध फ़ॉन्ट वेट (उदा. regular, 500, 700)।
सत्यापन फ़्लो में दिखाया जाने वाला सार्वजनिक नाम।
अंतिम उपयोगकर्ता को दिखाया गया गोपनीयता नीति URL।
प्रारंभिक स्वागत स्क्रीन छोड़ें।
Didit से लॉगिन करने वाली स्क्रीन दिखाने के बजाय अतिथि के रूप में जारी रखें। जब कस्टम डोमेन कॉन्फ़िगर किया गया हो, तो इसे वापस false पर सेट नहीं किया जा सकता (400)।
फ़्लो के दौरान प्रोग्रेस बार छिपाएं।
कॉलबैक URL पर रीडायरेक्ट करने से पहले विलंब (सेकंड)।
x >= 0जब true होता है, तो वर्तमान वर्गाकार लोगो को हटा देता है।
जब true होता है, तो वर्तमान आयताकार लोगो को हटा देता है।
जब true होता है, तो वर्तमान डार्क-मोड लोगो को हटा देता है, और logo_rectangular_dark तब null दिखाता है। यदि वही मल्टीपार्ट अनुरोध image_rectangular_dark भी अपलोड करता है, तो अपलोड प्राथमिकता लेता है।
जब true होता है, तो वर्तमान फ़ेविकॉन को हटा देता है।
प्रतिक्रिया
ब्रांडिंग अपडेट की गई। संपूर्ण ब्रांडिंग ऑब्जेक्ट वापस किया जाता है (सभी फ़ील्ड, केवल वे नहीं जिन्हें आपने बदला है)।
एप्लिकेशन के लिए व्हाइट लेबल ब्रांडिंग: रंग, फ़ॉन्ट, रेडियस, लोगो URL और UI/UX विकल्प। लोगो URL केवल पढ़ने के लिए हैं (उन्हें इमेज अपलोड करके सेट करें)। कस्टम डोमेन और व्हाइट लेबल ईमेल शामिल नहीं हैं।
केवल-पढ़ने योग्य। चयनित फ़ैमिली के लिए रिज़ॉल्व किया गया Google Fonts स्टाइलशीट URL।
वर्गाकार लोगो का केवल-पढ़ने योग्य URL। image_square के माध्यम से अपलोड करें।
आयताकार लोगो का केवल-पढ़ने योग्य URL। image_rectangular के माध्यम से अपलोड करें।
केवल-पढ़ने योग्य। डार्क मोड के लिए आयताकार लोगो का अस्थायी हस्ताक्षरित URL, जो डार्क बैकग्राउंड पर दिखाया जाता है। जब कोई डार्क लोगो सेट नहीं होता है या आपके खाते के लिए आयताकार लोगो नहीं दिखाए जाते हैं, तो null होता है। इसे image_rectangular_dark के साथ अपलोड करें।
फ़ेविकॉन का केवल-पढ़ने योग्य URL। image_favicon के माध्यम से अपलोड करें।