توثیق کا سیٹ اپ

Brevo آپ کے استعمال کے مطابق توثیق کے دو طریقے فراہم کرتا ہے: عام API رسائی کے لیے API کلید کی توثیق اور AI انٹیگریشنز کے لیے MCP ٹوکن کی توثیق۔ یہ گائیڈ دونوں طریقے بیان کرتی ہے۔

API کلید کی توثیق

Brevo API کلیدیں تمام Brevo خدمات تک عام REST API رسائی کے لیے استعمال ہوتی ہیں۔

اپنی API کلید بنائیں

1. اپنے Brevo ڈیش بورڈ میں سائن ان کریں
2. Settings → 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 کے APIs تک معیاری AI رسائی ان کے ذریعے فراہم کرتا ہے:

• ٹرانسپورٹ: HTTPS
• بنیادی URL: https://mcp.brevo.com/v1/
• جواب کا فارمیٹ: JSON
• توثیق: MCP ٹوکن (API کلیدوں سے مختلف)

اپنا MCP ٹوکن بنائیں

1. اپنے Brevo ڈیش بورڈ میں سائن ان کریں
2. Settings → 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 پابندیاں ہوتی ہیں
• اگر آپ کو IPs وائٹ لسٹ کروانی ہوں تو سپورٹ سے رابطہ کریں

MCP ٹوکن کے عام مسائل

MCP دستیاب نہیں

• یقینی بنائیں کہ آپ کے پاس MCP فیچرز تک ابتدائی رسائی ہے
• رسائی کی درخواست کے لیے Brevo سپورٹ سے رابطہ کریں

غلط ٹوکن

• تصدیق کریں کہ ٹوکن بغیر خالی جگہوں کے درست کاپی ہوا ہے
• جانچیں کہ ٹوکن کی میعاد ختم یا منسوخ تو نہیں ہوئی

غلط بنیادی URL

• MCP ٹوکنز صرف mcp.brevo.com کے ساتھ کام کرتے ہیں
• MCP ٹوکنز کو api.brevo.com اینڈ پوائنٹس کے ساتھ استعمال نہ کریں

اگلے اقدامات

• ریٹ لمٹس کے بارے میں جانیں
• SDK انسٹال کریں
• اپنی پہلی API کال کریں