ऑथेंटिकेशन सेटअप

आपके उपयोग के हिसाब से Brevo दो ऑथेंटिकेशन तरीके देता है: स्टैंडर्ड API पहुंच के लिए API की ऑथेंटिकेशन और AI इंटीग्रेशन के लिए MCP टोकन ऑथेंटिकेशन. यह गाइड दोनों तरीकों को कवर करती है.

API की ऑथेंटिकेशन

Brevo API की का उपयोग सभी Brevo सेवाओं तक स्टैंडर्ड REST API पहुंच के लिए किया जाता है.

अपनी API की जनरेट करें

1. अपने Brevo डैशबोर्ड में लॉग इन करें
2. सेटिंग्स → API Keys पर जाएं
3. Generate a New API Key पर क्लिक करें
4. अपनी की को एक स्पष्ट नाम दें (जैसे, “My App Production”)
5. की को सुरक्षित रूप से कॉपी करके स्टोर करें (आप इसे दोबारा नहीं देख पाएंगे!)

API की सुरक्षा के सर्वोत्तम तरीके

✅ ये करें

• एनवायरनमेंट वेरिएबल का उपयोग करके की को सुरक्षित रूप से स्टोर करें
• डेवलपमेंट और प्रोडक्शन के लिए अलग-अलग की का उपयोग करें
• की को नियमित रूप से रोटेट करें (हर 90 दिन में सुझाया जाता है)
• की की अनुमतियां सीमित रखें, सिर्फ़ उतनी जितनी ज़रूरी हैं
• अपने डैशबोर्ड में की के उपयोग पर नज़र रखें

❌ ये न करें

• की को कभी भी वर्ज़न कंट्रोल में कमिट न करें
• अपने ऐप्लिकेशन में की को हार्डकोड न करें
• ईमेल या चैट के ज़रिए की साझा न करें
• टेस्टिंग के लिए प्रोडक्शन की का उपयोग न करें

एनवायरनमेंट वेरिएबल

अपनी API की को एनवायरनमेंट वेरिएबल के रूप में स्टोर करें:

Linux/macOS (.bashrc या .zshrc)

export BREVO_API_KEY="your_api_key_here"

Windows (Command Prompt)

set BREVO_API_KEY=your_api_key_here

Node.js (.env फ़ाइल)

BREVO_API_KEY=your_api_key_here

// Load from environment
const apiKey = process.env.BREVO_API_KEY;

Python

import os

api_key = os.getenv('BREVO_API_KEY')

PHP

$apiKey = $_ENV['BREVO_API_KEY'];
// or
$apiKey = getenv('BREVO_API_KEY');

ऑथेंटिकेशन हेडर

अपनी API की को रिक्वेस्ट हेडर में शामिल करें:

स्टैंडर्ड हेडर फ़ॉर्मैट

GET /v3/account HTTP/1.1
Host: api.brevo.com
Accept: application/json
api-key: your_api_key_here

JavaScript उदाहरण

const headers = {
  'Accept': 'application/json',
  'api-key': process.env.BREVO_API_KEY
};

fetch('https://api.brevo.com/v3/account', { headers })
  .then(response => response.json())
  .then(data => console.log(data));

Python Requests

import requests

headers = {
    'Accept': 'application/json',
    'api-key': os.getenv('BREVO_API_KEY')
}

response = requests.get('https://api.brevo.com/v3/account', headers=headers)

की की अनुमतियां और स्कोप

अलग-अलग API की के पास अलग-अलग अनुमतियां हो सकती हैं:

• केवल पढ़ने के लिए: सिर्फ़ GET रिक्वेस्ट की अनुमति
• ईमेल भेजना: ट्रांज़ैक्शनल ईमेल की अनुमतियां
• कॉन्टैक्ट प्रबंधन: कॉन्टैक्ट बनाना, अपडेट करना, डिलीट करना
• कैम्पेन प्रबंधन: कैम्पेन बनाना और भेजना
• पूर्ण पहुंच: सभी API एंडपॉइंट

अपने ऑथेंटिकेशन की टेस्टिंग

अपना ऑथेंटिकेशन काम कर रहा है या नहीं, यह सत्यापित करने के लिए इस एंडपॉइंट का उपयोग करें:

curl -X GET "https://api.brevo.com/v3/account" \
  -H "Accept: application/json" \
  -H "api-key: $BREVO_API_KEY"

सफल रिस्पॉन्स (200 OK):

{
  "email": "[email protected]",
  "firstName": "John",
  "lastName": "Doe"
}

ऑथेंटिकेशन एरर (401 Unauthorized):

{
  "code": "unauthorized",
  "message": "Invalid API key provided"
}

की रोटेशन

अपनी API की रोटेट करने के लिए:

1. डैशबोर्ड में एक नई की जनरेट करें
2. नई की के साथ अपने एनवायरनमेंट वेरिएबल अपडेट करें
3. नई की के साथ अपना ऐप्लिकेशन डिप्लॉय करें
4. सब कुछ ठीक चल रहा है, यह पक्का करने के लिए अच्छी तरह टेस्ट करें
5. नई की पर भरोसा हो जाने के बाद पुरानी की रद्द करें

API की के उपयोग की निगरानी

Brevo डैशबोर्ड में अपनी API की के उपयोग को ट्रैक करें:

• प्रति दिन/महीना रिक्वेस्ट
• एंडपॉइंट के अनुसार एरर दरें
• भौगोलिक उपयोग पैटर्न
• सबसे व्यस्त उपयोग समय

कई API की की रणनीति

बड़े ऐप्लिकेशन के लिए, कई API की का उपयोग करने पर विचार करें:

• प्रोडक्शन: लाइव ग्राहक डेटा और ईमेल
• स्टेजिंग: प्री-प्रोडक्शन टेस्टिंग
• डेवलपमेंट: लोकल डेवलपमेंट और टेस्टिंग
• मॉनिटरिंग: हेल्थ चेक और मेट्रिक्स
• थर्ड-पार्टी: बाहरी इंटीग्रेशन

MCP टोकन ऑथेंटिकेशन

Brevo Model Context Protocol (MCP) एक AI इंटीग्रेशन फ़्रेमवर्क है जो AI असिस्टेंट को Brevo सेवाओं के साथ काम करने देता है. MCP, MCP टोकन के ज़रिए एक अलग ऑथेंटिकेशन तरीका इस्तेमाल करता है.

MCP क्या है?

MCP इनके ज़रिए Brevo API तक मानकीकृत AI पहुंच देता है:

• ट्रांसपोर्ट: HTTPS
• बेस URL: https://mcp.brevo.com/v1/
• रिस्पॉन्स फ़ॉर्मैट: JSON
• ऑथेंटिकेशन: MCP टोकन (API की से अलग)

अपना MCP टोकन जनरेट करें

1. अपने Brevo डैशबोर्ड में लॉग इन करें
2. सेटिंग्स → MCP Tokens (या अकाउंट सेटिंग्स) पर जाएं
3. एक नया MCP टोकन जनरेट करें
4. टोकन को सुरक्षित रूप से कॉपी करके स्टोर करें

ध्यान दें: MCP फ़िलहाल केवल अर्ली एक्सेस उपयोगकर्ताओं के लिए उपलब्ध है.

MCP टोकन का उपयोग

MCP टोकन ख़ास तौर पर AI इंटीग्रेशन और Model Context Protocol कनेक्शन के लिए इस्तेमाल होते हैं:

export BREVO_MCP_TOKEN="your_mcp_token_here"

MCP एंडपॉइंट पर भेजी जाने वाली रिक्वेस्ट में MCP टोकन शामिल करें:

GET /v1/account HTTP/1.1
Host: mcp.brevo.com
Accept: application/json
Authorization: Bearer your_mcp_token_here

MCP बनाम API की

MCP सुरक्षा के सर्वोत्तम तरीके

• MCP टोकन को API की से अलग स्टोर करें
• टोकन स्टोर करने के लिए एनवायरनमेंट वेरिएबल का उपयोग करें
• टोकन नियमित रूप से रोटेट करें
• टोकन कभी भी वर्ज़न कंट्रोल में कमिट न करें
• अपने डैशबोर्ड में MCP उपयोग पर नज़र रखें

ऑथेंटिकेशन से जुड़ी समस्याओं का समाधान

API की की आम समस्याएं

अमान्य API की फ़ॉर्मैट

• की ठीक 64 अक्षर लंबी होनी चाहिए
• अतिरिक्त स्पेस या अक्षरों की जांच करें

अनुमति एरर

• सत्यापित करें कि आपकी की के पास ज़रूरी अनुमतियां हैं
• जांचें कि की आपके डैशबोर्ड में सक्रिय है या नहीं

रेट लिमिटिंग

• ऑथेंटिकेशन विफलताएं भी रेट लिमिट में गिनी जाती हैं
• सही क्रेडेंशियल के साथ दोबारा कोशिश करने से पहले प्रतीक्षा करें

भौगोलिक प्रतिबंध

• कुछ अकाउंट पर IP प्रतिबंध होते हैं
• IP को व्हाइटलिस्ट करवाना हो तो सपोर्ट से संपर्क करें

MCP टोकन की आम समस्याएं

MCP उपलब्ध नहीं है

• पक्का करें कि आपके पास MCP सुविधाओं का अर्ली एक्सेस है
• पहुंच का अनुरोध करने के लिए Brevo सपोर्ट से संपर्क करें

अमान्य टोकन

• सत्यापित करें कि टोकन बिना स्पेस के सही तरीके से कॉपी हुआ है
• जांचें कि टोकन की समय-सीमा समाप्त या रद्द तो नहीं हुई है

ग़लत बेस URL

• MCP टोकन सिर्फ़ mcp.brevo.com के साथ काम करते हैं
• api.brevo.com एंडपॉइंट के साथ MCP टोकन का उपयोग न करें

अगले कदम

• रेट लिमिट के बारे में जानें
• एक SDK इंस्टॉल करें
• अपनी पहली API कॉल करें