API - अवलोकन

API - फ़ाइलें, फ़ॉन्ट और मुद्राएँ

सार्वजनिक और सुरक्षित फ़ाइलें डाउनलोड करें तथा फ़ॉन्ट की सूची और उपलब्ध मुद्राएँ प्राप्त करें।

एंडपॉइंट का अवलोकन

विधिएंडपॉइंटविवरणऐक्सेस
GET/public-api/v1/file/public/products/:productId/:sizeसार्वजनिक उत्पाद प्रीव्यू लौटाता है। आकार small.png, medium.png या big.png होना चाहिए।सार्वजनिक
GET/public-api/v1/file/protected/:keyस्टोरेज कुंजी से सुरक्षित फ़ाइल लौटाता है।हस्ताक्षरित URL या files:read
GET/public-api/v1/fontsसभी उपलब्ध फ़ॉन्ट लौटाता है।सार्वजनिक
GET/public-api/v1/currenciesसभी मुद्राएँ लौटाता है।सार्वजनिक

फ़ाइलें, फ़ॉन्ट और मुद्राएँ

सार्वजनिक प्रीव्यू फ़ाइलें सीधे ब्राउज़र में इस्तेमाल की जा सकती हैं। सुरक्षित फ़ाइलों के लिए हस्ताक्षरित URL या files:read अनुमति वाला API क्रेडेंशियल चाहिए। फ़ॉन्ट और मुद्रा एंडपॉइंट सार्वजनिक रूप से पढ़े जा सकते हैं।

एंडपॉइंटऐक्सेसविवरण
/file/public/products/:productId/small.pngसार्वजनिकछोटा उत्पाद प्रीव्यू।
/file/public/products/:productId/medium.pngसार्वजनिकमध्यम उत्पाद प्रीव्यू।
/file/public/products/:productId/big.pngसार्वजनिकबड़ा उत्पाद प्रीव्यू।
/file/protected/:keyहस्ताक्षरित URL या files:readसुरक्षित ऑब्जेक्ट स्टोरेज फ़ाइल।
/fontsसार्वजनिकफ़ॉन्ट रिकॉर्ड की ऐरे।
/currenciesसार्वजनिकमुद्रा रिकॉर्ड की ऐरे।

उदाहरण अनुरोध (fetch)

const publicPreview = await fetch(
  'https://alterproduct.com/public-api/v1/file/public/products/4/medium.png'
);

const protectedFile = await fetch(
  'https://alterproduct.com/public-api/v1/file/protected/user_34/381/design/mockup-large.webp',
  {
    headers: authHeaders
  }
);

const fonts = await fetch('https://alterproduct.com/public-api/v1/fonts').then((res) => res.json());
const currencies = await fetch('https://alterproduct.com/public-api/v1/currencies').then((res) => res.json());

उदाहरण जवाब

[
  {
    "id": 1,
    "family": "Inter",
    "source": "google",
    "category": "sans-serif",
    "variants": ["regular", "600", "700"],
    "subsets": ["latin"],
    "version": "v19",
    "menu": "Inter",
    "files": {
      "regular": "https://..."
    }
  }
]
[
  {
    "id": 1,
    "code": "EUR",
    "name": "Euro",
    "symbol": "€",
    "decimalPlaces": 2
  }
]