Skip to main content

​
API ключ

Все запросы к Love&Pay API требуют аутентификации с помощью API ключа. Ключ передаётся в заголовке x-api-key. 
curl -X GET "https://loveandpay.io/api/v1/invoices" \
  -H "x-api-key: YOUR_API_KEY"

​
Получение API ключа

1

Войдите в панель управления

Перейдите в панель управления и войдите в свой аккаунт.
2

Перейдите в настройки API

В боковом меню выберите Настройки → API ключи.
3

Создайте новый ключ

Нажмите Создать ключ и укажите название для идентификации.
4

Сохраните ключ

Скопируйте и сохраните ключ в безопасном месте. Ключ показывается только один раз.

​
Безопасность

Никогда не передавайте API ключ в публичный код или клиентские приложения. Храните ключи только на сервере.

​
Рекомендации

  • Используйте переменные окружения для хранения ключей
  • Регулярно ротируйте ключи
  • Создавайте отдельные ключи для разных сред (разработка, продакшн)
  • Немедленно отзывайте скомпрометированные ключи

​
Пример использования

const response = await fetch('https://loveandpay.io/api/v1/invoices', {
  method: 'GET',
  headers: {
    'x-api-key': process.env.LOVEANDPAY_API_KEY,
    'Content-Type': 'application/json'
  }
});

const data = await response.json();

​
Тестирование API в документации

Вы можете тестировать API запросы прямо из этой документации! На каждой странице эндпоинта справа есть панель API Playground.
1

Откройте страницу эндпоинта

Например, Создание счёта
2

Введите API ключ

В правой панели нажмите на поле x-api-key и вставьте ваш ключ. Он сохранится в браузере для всех запросов.
3

Заполните параметры

Укажите необходимые параметры запроса (amount, currency и т.д.)
4

Отправьте запрос

Нажмите Send и увидите реальный ответ от API
API ключ сохраняется локально в вашем браузере и не передаётся никуда кроме серверов Love&Pay.

​
Коды ошибок аутентификации

КодОписание
401API ключ отсутствует или недействителен
403API ключ не имеет доступа к запрашиваемому ресурсу
429Превышен лимит запросов

​
Ограничения и защита API

Для обеспечения стабильной работы сервиса и защиты от злоупотреблений, Love&Pay использует систему мониторинга API запросов.

​
Лимиты запросов

При нормальном использовании API вы не столкнётесь с ограничениями. Однако система автоматически отслеживает аномальную активность:
  • Чрезмерно частые запросы за короткий промежуток времени
  • Большое количество неудачных попыток аутентификации
  • Подозрительные паттерны использования API

​
Блокировка API ключа

В случае обнаружения подозрительной активности, система безопасности может временно заблокировать ваш API ключ для защиты вашего аккаунта и предотвращения возможных атак.
При блокировке API будет возвращать ошибку: 
{
  "error": "API_KEY_SUSPENDED",
  "message": "Ваш API ключ временно заблокирован из-за подозрительной активности"
}

​
Что делать если ключ заблокирован?

1

Не паникуйте

Блокировка — это мера предосторожности. Ваши данные в безопасности.
2

Проверьте свой код

Убедитесь, что в вашем коде нет бесконечных циклов или ошибок, вызывающих массовые запросы.
3

Свяжитесь с поддержкой

Напишите нам в онлайн-чат на сайте loveandpay.io — мы быстро разберёмся в ситуации и разблокируем ключ.
4

Переиндексируйте ключ

После снятия блокировки перейдите в настройки API и нажмите Переиндексировать рядом с вашим ключом. Без этого шага ключ не заработает!
Важно: После разблокировки обязательно переиндексируйте API ключ в панели управления. Без переиндексации ключ останется неактивным.

Онлайн-чат поддержки

Наша команда поддержки доступна в онлайн-чате на сайте loveandpay.io. Мы оперативно поможем разблокировать API ключ и разобраться в причинах блокировки.

​
Рекомендации для стабильной работы

Используйте кэширование

Кэшируйте ответы API где возможно, чтобы уменьшить количество запросов

Обрабатывайте ошибки

Реализуйте exponential backoff при получении ошибок 429 или 5xx

Batch запросы

Используйте Batch API для массовых операций вместо множества отдельных запросов

Вебхуки вместо polling

Настройте вебхуки для получения уведомлений вместо постоянного опроса API