Начать

Аутентификация с помощью API ключей

Каждый эндпоинт, кроме двух эндпоинтов ценообразования, требует API ключа в заголовке Authorization.

POST /v1/messages HTTP/1.1
Host: bulksmsapi.cc
Authorization: Bearer bsa_live_7QzX2mW9kR4tB8nV1cJ6yP3sH5dL0aFe
Content-Type: application/json

Создание ключей

  • Ключи создаются на странице API ключей в консоли. Страница открывается после первого пополнения баланса.
  • Аккаунт может содержать 10 активных ключей. Дайте каждому приложению или окружению свой ключ и имя, чтобы один можно было заменить, не затрагивая другие.
  • Ключ начинается с bsa_live_ и за ним следуют 32 буквы и цифры. Он показывается только один раз при создании; мы храним только хэш с ключом, поэтому потерянный ключ нельзя показать снова. Вместо этого создайте новый.
  • Список показывает первые символы, последние четыре, когда ключ был создан и когда он использовался в последний раз.

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

Чтобы сменить ключ без простоя: создайте второй ключ, разверните его, проверьте время последнего использования в консоли, затем отзовите старый ключ. Отозванный ключ отвечает 401 unauthorized начиная со следующего запроса.

Безопасное хранение ключей

  • Вызывайте API с вашего сервера, никогда из браузера или мобильного приложения: любой, у кого есть ключ, может отправлять сообщения с вашего баланса.
  • Храните ключи в переменных окружения или менеджере секретов, а не в системе контроля версий.
  • Каждый ключ имеет свой счетчик ограничения запросов, поэтому занятый воркер не замедляет второй ключ, используемый в другом месте.

Ошибки

401 UnauthorizedJSON
{
  "error": {
    "code": "unauthorized",
    "message": "Send your API key as Authorization: Bearer bsa_live_... Keys are created in the console under API keys.",
    "doc_url": "https://bulksmsapi.cc/en/docs/errors#unauthorized"
  }
}
Аутентификация с помощью API ключей | Документация BulkSMSAPI