Подайте заявку на ранний доступ

Укажите имя, а также email или номер телефона. Мы отправим Вам информацию о доступе к Tajo.

Настройка аутентификации

Brevo предлагает два способа аутентификации в зависимости от сценария: аутентификация по API-ключу для обычного доступа к API и аутентификация по MCP-токену для ИИ-интеграций. Это руководство описывает оба способа.

Аутентификация по 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 дней)
  • Ограничивайте права ключа только необходимыми
  • Отслеживайте использование ключа в панели управления

❌ Чего не делать

  • Никогда не добавляйте ключи в систему контроля версий
  • Не зашивайте ключи в код приложения
  • Не передавайте ключи по email или в чате
  • Не используйте продакшен-ключи для тестирования

Переменные окружения

Храните API-ключи в переменных окружения:

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

Terminal window
export BREVO_API_KEY="your_api_key_here"

Windows (командная строка)

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

Проверка аутентификации

Используйте этот эндпоинт, чтобы убедиться, что аутентификация работает:

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-ключей:

  • Production: реальные данные клиентов и письма
  • Staging: предпродакшен-тестирование
  • Development: локальная разработка и тестирование
  • Monitoring: проверки работоспособности и метрики
  • Third-party: внешние интеграции

Аутентификация по MCP-токену

Brevo Model Context Protocol (MCP): это фреймворк ИИ-интеграции, который позволяет ИИ-ассистентам взаимодействовать с сервисами Brevo. MCP использует отдельный способ аутентификации, через MCP-токены.

Что такое MCP?

MCP даёт ИИ стандартизированный доступ к API Brevo:

  • Транспорт: HTTPS
  • Базовый URL: https://mcp.brevo.com/v1/
  • Формат ответа: JSON
  • Аутентификация: MCP-токен (отличается от API-ключей)

Создайте MCP-токен

  1. Войдите в свою панель управления Brevo
  2. Перейдите в SettingsMCP Tokens (или в настройки аккаунта)
  3. Создайте новый MCP-токен
  4. Скопируйте и сохраните токен в надёжном месте

Примечание: сейчас MCP доступен только пользователям с ранним доступом.

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

MCP-токены применяются именно для ИИ-интеграций и подключений по 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 APIИИ-интеграции и подключения 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

Следующие шаги

Подайте заявку на ранний доступ

Укажите имя, а также email или номер телефона. Мы отправим Вам информацию о доступе к Tajo.

определим автоматически
AI-ассистент

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