Заявете ранен достъп

Посочете името си и имейл адрес или телефонен номер. Ще Ви изпратим информация за достъп до Tajo.

Настройка на удостоверяването

Brevo предлага два метода за удостоверяване в зависимост от Вашия случай на употреба: удостоверяване с API ключ за стандартен достъп до API и удостоверяване с MCP токен за AI интеграции. Това ръководство описва и двата метода.

Удостоверяване с API ключ

API ключовете на Brevo се използват за стандартен достъп през REST API до всички услуги на Brevo.

Генериране на Вашия API ключ

  1. Влезте в Вашето табло в Brevo
  2. Отидете в SettingsAPI Keys
  3. Кликнете върху Generate a New API Key
  4. Дайте на ключа описателно име (например „My App Production”)
  5. Копирайте и съхранете ключа на сигурно място (няма да го видите отново!)

Добри практики за сигурност на API ключовете

✅ ПРАВЕТЕ

  • Съхранявайте ключовете сигурно чрез променливи на средата
  • Използвайте различни ключове за разработка и за продукция
  • Ротирайте ключовете редовно (препоръчително на всеки 90 дни)
  • Ограничавайте правата на ключа само до необходимото
  • Следете използването на ключа във Вашето табло

❌ НЕ ПРАВЕТЕ

  • Никога не качвайте ключове в системата за контрол на версиите
  • Не записвайте ключове твърдо в кода на приложението си
  • Не споделяйте ключове по имейл или чат
  • Не използвайте продукционни ключове за тестване

Променливи на средата

Съхранявайте API ключовете си като променливи на средата:

Linux/macOS (.bashrc или .zshrc)

Terminal window
export BREVO_API_KEY="your_api_key_here"

Windows (Command Prompt)

Terminal window
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

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

Тестване на удостоверяването

Използвайте тази крайна точка, за да проверите дали удостоверяването работи:

Terminal window
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 ключа

Проследявайте използването на своя API ключ в таблото на Brevo:

  • Заявки на ден/месец
  • Процент грешки по крайна точка
  • Географски модели на използване
  • Часове на пиково натоварване

Стратегия с няколко API ключа

За по-големи приложения обмислете използването на няколко API ключа:

  • Продукция: реални клиентски данни и имейли
  • Staging: тестване преди продукция
  • Разработка: локална разработка и тестване
  • Мониторинг: проверки на състоянието и показатели
  • Външни доставчици: интеграции с трети страни

Удостоверяване с MCP токен

Brevo Model Context Protocol (MCP) е рамка за AI интеграция, която позволява на AI асистентите да взаимодействат с услугите на Brevo. MCP използва отделен метод за удостоверяване чрез MCP токени.

Какво е MCP?

MCP осигурява стандартизиран AI достъп до API на Brevo чрез:

  • Транспорт: HTTPS
  • Базов URL: https://mcp.brevo.com/v1/
  • Формат на отговора: JSON
  • Удостоверяване: MCP токен (различен от API ключовете)

Генериране на Вашия MCP токен

  1. Влезте в Вашето табло в Brevo
  2. Отидете в SettingsMCP Tokens (или настройки на акаунта)
  3. Генерирайте нов MCP токен
  4. Копирайте и съхранете токена на сигурно място

Забележка: MCP в момента е достъпен само за потребители с ранен достъп.

Използване на MCP токени

MCP токените се използват специално за AI интеграции и връзки по Model Context Protocol:

Terminal window
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 ключ

ХарактеристикаAPI ключMCP токен
Случай на употребаСтандартен достъп през REST APIAI интеграция и MCP връзки
Базов URLapi.brevo.commcp.brevo.com
Хедърapi-keyAuthorization: Bearer
НаличностВсички потребителиПотребители с ранен достъп

Добри практики за сигурност при MCP

  • Съхранявайте MCP токените отделно от API ключовете
  • Използвайте променливи на средата за съхранение на токените
  • Ротирайте токените редовно
  • Никога не качвайте токени в системата за контрол на версиите
  • Следете използването на MCP във Вашето табло

Отстраняване на проблеми с удостоверяването

Чести проблеми с API ключовете

Невалиден формат на API ключа

  • Ключовете трябва да са с дължина точно 64 знака
  • Проверете за излишни интервали или знаци

Грешка с правата

  • Проверете дали ключът има необходимите права
  • Проверете дали ключът е активен във Вашето табло

Ограничаване на заявките

  • Неуспешните удостоверявания се броят към лимита на заявките
  • Изчакайте, преди да опитате отново с коректни данни

Географски ограничения

  • Някои акаунти имат ограничения по IP
  • Свържете се с поддръжката, ако трябва да добавите IP адреси в белия списък

Чести проблеми с MCP токените

MCP не е наличен

  • Уверете се, че имате ранен достъп до функциите на MCP
  • Свържете се с поддръжката на Brevo, за да заявите достъп

Невалиден токен

  • Проверете дали токенът е копиран правилно, без интервали
  • Проверете дали токенът не е изтекъл или отменен

Грешен базов URL

  • MCP токените работят само с mcp.brevo.com
  • Не използвайте MCP токени с крайните точки на api.brevo.com

Следващи стъпки

Заявете ранен достъп

Посочете името си и имейл адрес или телефонен номер. Ще Ви изпратим информация за достъп до Tajo.

автоматично разпознаване
AI асистент

Здравейте! Попитайте ме за документацията.