TS Api

Начало работы | Общие сведения

Что такое API?

API (от англ. application programming interface – программный интерфейс приложения) – это интерфейс, который дает возможность с помощью специальных команд управлять каким-либо программным обеспечением (приложением, сервисом, программой и т.п.).

Для чего используют API

API используется для достижения различных бизнес-целей. В данной документации мы предлагаем вам описание тех методов API, которыми вы сами сможете оперировать для выполнения своих бизнес-задач.

Начало работы | Особенности API

Протокол передачи данных

API поддерживает как HTTP-, так и HTTPS-протоколы.

Формат запросов

В API используются POST- и GET-запросы. Тип запроса указан отдельно для каждого метода.

Авторизация

Все запросы требуют Basic Auth, доступы аналогичны доступам в личный кабинет.

Структура запроса

Используется JSON-формат для отправляемых данных

Формат ответа

Форматом ответа является JSON.

Формат запросов

В API используются POST- и GET-запросы. Тип запроса указан отдельно для каждого метода.

Структура имени URL-запросов

Каждый URL начинается с адреса API (https://tg.bizandsoft.ru/api), за ним следует название метода.

Боты | Список ботов

Метод

GET /bots

Описание

Метод позволяет получить список ботов в аккаунте.

Ограничения

Метод доступен в соответствии с правами пользователя.

{
    "status": true,
    "result_code": 200,
    "message": "Success!"
}

Боты | Поля бота

Метод

GET /bots/{id}

Описание

Метод позволяет получить информацию по боту.

Ограничения

Метод доступен в соответствии с правами пользователя.

{
    "status": true,
    "result_code": 200,
    "message": "Success!"
}

Боты | Редактирование бота

Метод

PATCH /bots/{id}

Описание

Метод позволяет изменить поля бота.

Ограничения

Метод доступен в соответствии с правами пользователя.

{
    "status": true,
    "result_code": 200,
    "message": "Success!"
}

Боты | Добавление бота

Метод

POST /bots

Описание

Метод позволяет добавить бота.

Ограничения

Метод доступен в соответствии с правами пользователя.

{
    "status": true,
    "result_code": 200,
    "message": "Success!"
}

Шаблоны | Список шаблонов

Метод

GET /templates

Описание

Метод позволяет получить список шаблонов в аккаунте.

Ограничения

Метод доступен в соответствии с правами пользователя.

{
    "status": true,
    "result_code": 200,
    "message": "Success!"
}

Шаблоны | Поля шаблона

Метод

GET /templates/{id}

Описание

Метод позволяет получить поля шаблона.

Ограничения

Метод доступен в соответствии с правами пользователя.

{
    "status": true,
    "result_code": 200,
    "message": "Success!"
}

Шаблоны | Редактирование шаблона

Метод

PATCH /templates/{id}

Описание

Метод позволяет изменить поля шаблона.

Ограничения

Метод доступен в соответствии с правами пользователя.

{
    "status": true,
    "result_code": 200,
    "message": "Success!"
}

Шаблоны | Добавление шаблона

Метод

POST /templates

Описание

Метод позволяет добавить шаблон.

Ограничения

Метод доступен в соответствии с правами пользователя.

{
    "status": true,
    "result_code": 200,
    "message": "Success!"
}

Хуки | Список хуков

Метод

GET /hooks

Описание

Метод позволяет получить список хуков в аккаунте.

Ограничения

Метод доступен в соответствии с правами пользователя.

{
    "status": true,
    "result_code": 200,
    "message": "Success!"
}

Хуки | Поля хука

Метод

GET /hooks/{id}

Описание

Метод позволяет получить поля хука.

Ограничения

Метод доступен в соответствии с правами пользователя.

{
    "status": true,
    "result_code": 200,
    "message": "Success!"
}

Хуки | Редактирование хука

Метод

PATCH /hooks/{id}

Описание

Метод позволяет изменить поля хука.

Ограничения

Метод доступен в соответствии с правами пользователя.

{
    "status": true,
    "result_code": 200,
    "message": "Success!"
}

Хуки | Добавление хука

Метод

POST /hooks

Описание

Метод позволяет добавить хук.

Ограничения

Метод доступен в соответствии с правами пользователя.

{
    "status": true,
    "result_code": 200,
    "message": "Success!"
}

Каналы | Список каналов

Метод

GET /channels

Описание

Метод позволяет получить список каналов в аккаунте.

Ограничения

Метод доступен в соответствии с правами пользователя.

{
    "status": true,
    "result_code": 200,
    "message": "Success!"
}

Каналы | Поля канала

Метод

GET /channels/{id}

Описание

Метод позволяет получить поля канала.

Ограничения

Метод доступен в соответствии с правами пользователя.

{
    "status": true,
    "result_code": 200,
    "message": "Success!"
}

Каналы | Редактирование канала

Метод

PATCH /channels/{id}

Описание

Метод позволяет изменить поля канала.

Ограничения

Метод доступен в соответствии с правами пользователя.

{
    "status": true,
    "result_code": 200,
    "message": "Success!"
}

Каналы | Добавление канала

Метод

POST /channels

Описание

Метод позволяет добавить канал.

Ограничения

Метод доступен в соответствии с правами пользователя.

{
    "status": true,
    "result_code": 200,
    "message": "Success!"
}