Список методів API v1
Get
https://notify.shop/api/v1/tg/{shop_api_key}/getInviteKey
Отримання посилання на підписку в telegram бот
Посилання на підписку боту
Після того, як користувач перейде за посиланням та запустить бота телеграма. Сервіс Notify зробить запит на адресу, вказану в налаштуваннях сайту в особистому кабінеті та передасть дані користувача, а саме chat_id телеграма та key по якому відбувалася активація. Також буде передана інша інформація, яка буде відома для публічного доступу.
Заголовки
| Параметр | Тип | Формат | Опис |
|---|---|---|---|
Content-Type: application/json |
string |
Обов’язково | MIME тип відповіді |
Параметри
Даний endpoint без параметрів
Відповідь
| Параметр | Тип | Опис |
|---|---|---|
status |
string |
Результат запиту (success / error) |
message |
string |
Текст результату запиту |
data[key] |
string |
Згенерований ключ |
data[link] |
string |
Повне посилання на телеграм бот для підписки |
data[qr] |
string |
Посилання на телеграм бот для підписки у вигляді QR Code |
Get
https://notify.shop/api/v1/tg/{shop_api_key}/hook/{code}
Відправка шаблону повідомлення
Посилання формується відразу після створення шаблону. Для кожного шаблону формується своє унікальне посилання.
Заголовки
| Параметр | Тип | Формат | Опис |
|---|---|---|---|
Content-Type: application/json |
string |
Обов’язково | MIME тип відповіді |
Параметри
Параметри в даному endpoint залежать від шаблону та являються динамічними. Ні один з параметрів не є обов’язковим, навіть якщо він вказаний в шаблоні
Якщо будуть передані лишні параметри, вони не будуть враховані при відправці шаблону
Приклади шаблонів можна переглянути за посиланням
Відповідь
| Параметр | Тип | Опис |
|---|---|---|
status |
string |
Результат запиту (success / error) |
message |
string |
Текст результату запиту |
Get
https://notify.shop/api/v1/tg/{shop_api_key}/user_groups
Список груп для доданого сайту
Заголовки
| Параметр | Тип | Формат | Опис |
|---|---|---|---|
Content-Type: application/json |
string |
Обов’язково | MIME тип відповіді |
Без параметрів
Відповідь
| Параметр | Тип | Опис |
|---|---|---|
limit |
integer |
Кількість записів за запит |
totalCount |
integer |
Загальна кількість груп |
offset |
integer |
Зміщення при вибірці даних |
items |
array |
Масив груп з об’єктів. Детальніше про кожен параметр нижче |
items[0]->id |
integer |
ID групи |
items[0]->can_delete_users_from_group |
integer |
Можливість видалення користувачів з групи (1/0) |
items[0]->can_add_users_to_group |
integer |
Можливість додавання користувачів з групи (1/0) |
items[0]->active |
integer |
Активність групи (1/0) |
items[0]->system |
integer |
Чи являється група системною (1/0) |
items[0]->name |
string |
Назва групи |
items[0]->count |
integer |
Кількість користувачів в групі |
Post
https://notify.shop/api/v1/tg/{shop_api_key}/user_group
Редагування / Створення групи
Системні групи неможливо редагувати. Також неможливо створити системну групу.
Заголовки
| Параметр | Тип | Формат | Опис |
|---|---|---|---|
Content-Type: application/json |
string |
Обов’язково | MIME тип відповіді |
Параметри
| Параметр | Тип | Опис |
|---|---|---|
id |
integer |
ID групи для редагування. Якщо id не переданий - буде створена нова група |
name |
string |
Назва групи |
active |
integer |
Активність групи (1/0) |
Відповідь
| Параметр | Тип | Опис |
|---|---|---|
status |
string |
Результат запиту (success / error) |
message |
string |
Текст результату запиту |
Post
https://notify.shop/api/v1/tg/{shop_api_key}/user_group/{group_id}/remove
Видалення групи
Системну групу видалити не можливо
Заголовки
| Параметр | Тип | Формат | Опис |
|---|---|---|---|
Content-Type: application/json |
string |
Обов’язково | MIME тип відповіді |
Без параметрів
Відповідь
| Параметр | Тип | Опис |
|---|---|---|
status |
string |
Результат запиту (success / error) |
message |
string |
Текст результату запиту |
Post
https://notify.shop/api/v1/tg/{shop_api_key}/user_group/{group_id}/remove/{tg_user_id}
Видалення користувача з групи
Видаляти користувачів з системної групи "Всі користувачі" не можливо
Заголовки
| Параметр | Тип | Формат | Опис |
|---|---|---|---|
Content-Type: application/json |
string |
Обов’язково | MIME тип відповіді |
Без параметрів
Відповідь
| Параметр | Тип | Опис |
|---|---|---|
status |
string |
Результат запиту (success / error) |
message |
string |
Текст результату запиту |
Post
https://notify.shop/api/v1/tg/{shop_api_key}/user_group/{group_id}/linkuser/{tg_user_id}
Додати користувача в групу
Заголовки
| Параметр | Тип | Формат | Опис |
|---|---|---|---|
Content-Type: application/json |
string |
Обов’язково | MIME тип відповіді |
Без параметрів
Відповідь
| Параметр | Тип | Опис |
|---|---|---|
status |
string |
Результат запиту (success / error) |
message |
string |
Текст результату запиту |
Get
https://notify.shop/api/v1/tg/{shop_api_key}/user_group/{group_id}/users
Список користувачів в групі
Заголовки
| Параметр | Тип | Формат | Опис |
|---|---|---|---|
Content-Type: application/json |
string |
Обов’язково | MIME тип відповіді |
Без параметрів
Відповідь
| Параметр | Тип | Опис |
|---|---|---|
status |
string |
Результат запиту (success / error) |
message |
string |
Текст результату запиту |