API प्रमाणीकरण

API Key प्रमाणीकरण

ByByBG API को भेजे जाने वाले सभी अनुरोधों में अनुरोध हेडर के भीतर एक वैध API Key शामिल होना आवश्यक है।

आपकी API Key आपके अकाउंट, अनुरोध सीमाओं और सदस्यता योजना की सुरक्षित पहचान करती है।

अपनी API Key बनाएं

अपने डैशबोर्ड में लॉगिन करें और डेवलपर सेटिंग्स सेक्शन से एक निजी API Key बनाएं।

अनुरोध हेडर में API Key भेजें

हर API अनुरोध में X-API-KEY हेडर का उपयोग करके अपनी API Key शामिल करें।

X-API-KEY: YOUR_API_KEY

PHP प्रमाणीकरण उदाहरण

एक सरल PHP उदाहरण जो दिखाता है कि अनुरोध हेडर में API Key कैसे शामिल की जाती है।

<?php

$apiKey = "YOUR_API_KEY";

$headers = [
    "X-API-KEY: ".$apiKey
];

cURL प्रमाणीकरण उदाहरण

API का शीघ्र परीक्षण करने के लिए एक सरल प्रमाणित cURL अनुरोध उदाहरण।

curl -X POST https://api.bybybg.com/v1/remove-bg \
-H "X-API-KEY: YOUR_API_KEY" \
-F "file=@image.png"

सुरक्षा की सर्वोत्तम प्रक्रियाएँ

• फ्रंटएंड JavaScript कोड में API Keys कभी भी प्रदर्शित न करें।
• API Keys को सुरक्षित रूप से Environment Variables में संग्रहित करें।
• बेहतर सुरक्षा के लिए अपनी API Keys को समय-समय पर बदलते रहें।
• फ्रंटएंड एप्लिकेशन के लिए बैकएंड प्रॉक्सी सिस्टम का उपयोग करें।
• अपने बैकएंड सिस्टम को अनधिकृत पहुँच से सुरक्षित रखें।

सामान्य प्रमाणीकरण त्रुटियाँ

• अमान्य या समाप्त हो चुकी API Key का उपयोग करना।
• प्रमाणीकरण हेडर के बिना अनुरोध भेजना।
• गुप्त API Keys को वेबसाइटों पर सार्वजनिक रूप से प्रदर्शित करना।
• गलत हेडर नाम या फ़ॉर्मेट का उपयोग करना।

प्रमाणीकरण त्रुटियाँ