API: подключить Sender к сайту или CRM

#Что можно сделать через API

• подписать человека на группу подписчиков — например, после заявки или оплаты на сайте;
• отписать от одной группы или от всех;
• проверить, есть ли человек в базе и на что он подписан, и посчитать подписчиков;
• запустить бота или остановить его — так можно отправить человеку нужное сообщение;
• записать и прочитать переменные — номер заказа, тариф, город;
• получить списки групп подписчиков и ботов канала.

Отдельного метода «отправить сообщение» нет: сообщение отправляет бот, которого вы запускаете через API. Все методы с параметрами — в статье Методы API.

#Что понадобится

• Роль «Администратор» или «Владелец» — раздел Управление → Настройки видят только они.
• Программист или сервис интеграций, который умеет отправлять запросы по HTTPS.

#Получить ключ и отправить первый запрос

Ключ работает только с тем каналом, который выбран, когда вы его создаёте: на компьютере канал выбирают в шапке кабинета, на телефоне — внизу меню. Для другого сообщества или бота переключите канал и создайте отдельный ключ.

#Пример запроса

Подписать человека с ID 123456 на группу подписчиков номер 12:

curl -X POST https://getsender.io/api/ext/subscribers/add \
  -H "Authorization: Bearer snd_ваш_ключ" \
  -d vk_user_id=123456 \
  -d subscription_id=12

Что здесь что:

• https://getsender.io/api/ext/ — адрес API, дальше раздел и метод: subscribers/add — «подписчики → добавить»;
• Authorization: Bearer … — ваш ключ. Его можно передать и параметром access_token;
• vk_user_id — ID человека: во ВКонтакте — ID страницы, в Telegram и МАКС — ID пользователя. Скопировать ID можно в списке Аудитория → Подписчики (меню строки «Ещё» → «Скопировать ID») или в «Диалогах» — в карточке клиента рядом с перепиской;
• subscription_id — номер группы подписчиков. Он виден в адресе группы в кабинете, например /subscriptions/12.

Если всё получилось, Sender ответит:

{"success": true}

А если нет — вернёт номер и текст ошибки:

{"success": false, "error_code": 4, "error_message": "Пользователь не разрешил отправку сообщений"}

Что значит каждый номер — в разделе Коды ошибок.

#Ключи: лимиты и безопасность

• У канала — до 20 действующих ключей. Когда их 20, кнопка «Создать ключ» не нажимается: отзовите ненужный.
• Один ключ — до 20 запросов в секунду. Больше — ошибка 9 «Слишком много запросов».
• В списке у каждого ключа видно, когда он создан и когда использовался последний раз — или «не использовался».
• Кнопка «Отозвать» выключает ключ сразу и навсегда — Sender предупредит: «Запросы с этим ключом сразу перестанут работать. Отменить нельзя».

#Частые вопросы