API संदर्भ

एक एंडपॉइंट, कुछ नियंत्रण, दो प्रमाणन मोड।

संदर्भ से पहले माइग्रेशन पथ की आवश्यकता है?

शुरू करें Clearbit प्रतिस्थापन गाइड या logo API क्रेता गाइड से।

ClearLogo एकल HTTP एंडपॉइंट, GET /logo/{domain}, उजागर करता है, जो डोमेन के लोगो की एक PNG (या WebP/JPEG) सुसंगत अनुपात के साथ, एक अपारदर्शी, थीम-मिलान पृष्ठभूमि (लाइट के लिए सफेद, डार्क के लिए गहरा न्यूट्रल) पर लौटाता है। अनाम उपयोग कम-वॉल्यूम परीक्षण के लिए काम करता है; उत्पादन ट्रैफ़िक एक ब्राउज़र कुंजी (क्लाइंट) या सर्वर कुंजी (बैकएंड) का उपयोग करता है।

एंडपॉइंट

GET https://api.clearlogo.dev/logo/:domain

:domain कोई योजना या पथ के बिना एक खाली होस्टनाम है, उदाहरण के लिए github.com। API डिफ़ॉल्ट रूप से image/png लौटाता है।

क्वेरी पैरामीटर

नाम	प्रकार	डिफ़ॉल्ट	नोट्स
`size`	number	`128`	px में आउटपुट आयाम। केवल वर्ग। अनुमत मान: 16, 32, 48, 64, 96, 128, 192, 256, 512, 1024।
`frame`	`fill, original`	`fill`	`fill` लोगो की दृश्य सामग्री से कैनवास भरता है (पैडिंग घटाकर), स्रोत व्हाइटस्पेस छोड़ता है। `original` स्रोत आइकन की मूल फ्रेमिंग और अनुपात बनाए रखता है, ऐप-आइकन-शैली आसपास का व्हाइटस्पेस सहित।
`padding`	number	`10`	फ्रेम की गई सामग्री के प्रत्येक तरफ मार्जिन, कैनवास के % के रूप में (0–20, चरण 5)।
`shape`	`square, circle`	`square`	`square` मानक फ्रेमिंग है। `circle` लोगो को एक अंकित वृत्त के अंदर फिट करता है ताकि गोल अवतार में कटाई न हो — आउटपुट फिर भी एक वर्गाकार छवि है, कोई पारदर्शिता मास्क नहीं।
`part`	`full, logo, text`	`full`	यह चुनता है कि लोगो का कौन सा हिस्सा सर्व किया जाए — `full` (पूरा लोगो), `logo` (आइकन/मार्क), या `text` (वर्डमार्क) — उन डोमेन के लिए जिनका लोगो विभाजित किया गया है। यदि अनुरोधित हिस्सा उपलब्ध नहीं है, तो पूरे लोगो पर वापस आ जाता है (या अलग-अलग हिस्सों के रूप में प्रबंधित लोगो के लिए एक पारदर्शी छवि लौटाता है)। हिस्से रास्टर (PNG) हो सकते हैं और अपने वास्तविक रंगों में प्रस्तुत होते हैं।
`format`	`png \| webp \| jpeg`	`png`	आउटपुट फ़ॉर्मेट। `Accept` हेडर से स्वचालित रूप से अनुबंधित — आधुनिक ब्राउज़र `<img>` के माध्यम से स्वचालित रूप से WebP प्राप्त करते हैं।
`theme`	`light \| dark`	`light`	उपलब्ध होने पर अंधेरे संस्करण को रिटर्न करता है, अन्यथा हल्के को वापस करता है। अपारदर्शी पृष्ठभूमि भी सेट करता है: `light` के लिए सफेद, `dark` के लिए गहरा न्यूट्रल।
`token`	string	—	क्लाइंट कोड से उपयोग की जाने वाली ब्राउज़र कुंजी। Origin या Referer कुंजी पर एक अनुमत डोमेन से मेल खाना चाहिए।

विशिष्ट अनुरोध मुख्य नियंत्रणों का उपयोग करते हुए:

GET https://api.clearlogo.dev/logo/github.com?size=128&frame=fill&padding=10&shape=square

part के साथ विभाजित लोगो का केवल आइकन/मार्क अनुरोध करें:

GET https://api.clearlogo.dev/logo/github.com?size=128&part=logo

प्रमाणन

गुमनाम अनुरोध कम-वॉल्यूम परीक्षण के लिए काम करते हैं। उत्पादन ट्रैफ़िक के लिए, ब्राउज़र कुंजी (क्लाइंट) या सर्वर कुंजी (बैकएंड) का उपयोग करें:

ब्राउज़र

<img
  src="https://api.clearlogo.dev/logo/example.com?token=YOUR_BROWSER_KEY"
  alt="" />

सर्वर

curl \
  -H "Authorization: Bearer YOUR_SERVER_KEY" \
  "https://api.clearlogo.dev/logo/example.com"

दर सीमाएं

प्रति-कुंजी सीमाएं X-RateLimit-* हेडर में रिटर्न की जाती हैं। जब आप उन्हें अतिक्रम करते हैं तो API 429 के साथ प्रतिक्रिया करता है और एक Retry-After संकेत शामिल करता है।

सामान्य प्रश्न

मैं डोमेन के लिए लोगो कैसे प्राप्त करूं?

https://api.clearlogo.dev/logo/{domain} पर एक GET अनुरोध भेजें जहाँ {domain} एक github.com जैसा होस्टनाम है। कम-वॉल्यूम परीक्षण के लिए लॉगिन की आवश्यकता नहीं है। प्रतिक्रिया डिफ़ॉल्ट रूप से PNG है और सीधे <img> टैग में काम करती है।

ब्राउज़र कुंजी और सर्वर कुंजी में क्या अंतर है?

ब्राउज़र कुंजी फ्रंटएंड कोड और <img> टैग में शिप करने के लिए सुरक्षित है; अनुरोधों को कुंजी पर आपके द्वारा कॉन्फ़िगर किए गए अनुमत डोमेन के विरुद्ध मान्य किया जाता है। सर्वर कुंजी आपके बैकएंड से Authorization: Bearer हेडर के माध्यम से प्रमाणित होती है और कभी ब्राउज़र तक नहीं पहुँचनी चाहिए।

कौन से आउटपुट फ़ॉर्मेट समर्थित हैं?

png (डिफ़ॉल्ट), webp, और jpeg। जब format पैरामीटर छोड़ा जाता है, ClearLogo अनुरोध के Accept हेडर से सामग्री-वार्ता करता है — <img> टैग के माध्यम से लोड होने पर आधुनिक ब्राउज़र स्वचालित रूप से WebP प्राप्त करते हैं।

दर सीमाएं क्या हैं?

प्रति-कुंजी सीमाएं X-RateLimit-Limit, X-RateLimit-Remaining, और X-RateLimit-Reset प्रतिक्रिया हेडर में रिटर्न की जाती हैं। सीमा पार होने पर HTTP 429 और एक Retry-After संकेत मिलता है जो बताता है कि पुनः प्रयास से पहले कितने सेकंड प्रतीक्षा करें।

क्या मुझे पारदर्शी पृष्ठभूमि या वर्गाकार क्रॉप मिल सकता है?

आउटपुट हमेशा एक अपारदर्शी, वर्गाकार छवि होती है — कोई पारदर्शी संस्करण नहीं है। पृष्ठभूमि theme से मेल खाती है: light के लिए सफेद और dark के लिए गहरा न्यूट्रल। उस वर्गाकार कैनवास में आप फ्रेमिंग नियंत्रित करते हैं: frame (fill, original) — कैनवास को लोगो की सामग्री से भरना या स्रोत आइकन के मूल अनुपात बनाए रखना — padding (0–20, चरण 5) प्रत्येक तरफ मार्जिन सेट करता है, और shape (square, circle) को circle पर सेट करने पर लोगो एक अंकित वृत्त के अंदर फिट होता है (फिर भी वर्गाकार छवि पर रेंडर)। size (अनुमत: 16, 32, 48, 64, 96, 128, 192, 256, 512, 1024) सटीक पिक्सेल आयाम देता है। जिन डोमेन का लोगो विभाजित किया गया है, उनके लिए part (full, logo, text) पूरा लोगो (full, डिफ़ॉल्ट), आइकन/मार्क (logo), या वर्डमार्क (text) चुनता है और अनुरोधित हिस्सा उपलब्ध न होने पर पूरे लोगो पर वापस आ जाता है (या अलग-अलग हिस्सों के रूप में प्रबंधित लोगो के लिए एक पारदर्शी छवि लौटाता है)।