# 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। |
| `content` | number | `80` | कैनवास के अंदर लोगो पदचिह्न (50–100, चरण 5)। |
| `format` | `png \| webp \| jpeg` | `png` | आउटपुट फ़ॉर्मेट। `Accept` हेडर से स्वचालित रूप से अनुबंधित — आधुनिक ब्राउज़र `<img>` के माध्यम से स्वचालित रूप से WebP प्राप्त करते हैं। |
| `theme` | `light \| dark` | `light` | उपलब्ध होने पर अंधेरे संस्करण को रिटर्न करता है, अन्यथा हल्के को वापस करता है। |
| `token` | string | — | क्लाइंट कोड से उपयोग की जाने वाली ब्राउज़र कुंजी। Origin या Referer कुंजी पर एक अनुमत डोमेन से मेल खाना चाहिए। |

## प्रमाणन

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

**ब्राउज़र**

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

**सर्वर**

```bash
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 प्राप्त करते हैं।