🇷🇺

Аутентификация

Аутентификация в API myumbrella.ai с помощью API-ключей и OAuth 2.0.

Аутентификация

Все API-запросы требуют аутентификации. myumbrella.ai поддерживает два метода аутентификации: API-ключи для межсерверных вызовов и OAuth 2.0 для пользовательских интеграций.

API-ключи

Сгенерируйте API-ключи в Настройки → API-ключи. Каждый ключ привязан к определённым разрешениям.

Включите ваш API-ключ в заголовок Authorization:

curl -X GET https://api.myumbrella.ai/v1/plans \
  -H "Authorization: Bearer mu_live_abc123def456" \
  -H "Content-Type: application/json"

Типы ключей

Тип	Префикс	Сценарий использования
Live	`mu_live_`	Производственные API-вызовы
Test	`mu_test_`	Тестирование в песочнице (без реальных списаний)

OAuth 2.0

Для приложений, действующих от имени продавцов, используйте OAuth-процесс:

Перенаправьте продавца на:

https://app.myumbrella.ai/oauth/authorize?client_id=YOUR_ID&redirect_uri=YOUR_URI&scope=plans:read+claims:write

После авторизации обменяйте код на токен доступа:

curl -X POST https://api.myumbrella.ai/oauth/token \
  -d "grant_type=authorization_code" \
  -d "code=AUTH_CODE" \
  -d "client_id=YOUR_ID" \
  -d "client_secret=YOUR_SECRET"

Ограничения частоты запросов

Live-ключи: 1 000 запросов/минуту
Test-ключи: 100 запросов/минуту
Заголовки ограничения: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset

Ответы об ошибках

Ошибки аутентификации возвращают статус 401:

{
  "error": "unauthorized",
  "message": "Invalid or expired API key"
}

Аутентификация