Интерфейсы
REST API раздела «Интерфейсы»: 34 операции.
Базовый адрес: https://api.legalstack.ru. Спецификация: openapi/interfaces.json.
Управление интерфейсами
Формы для сбора данных.
Доступ по API-токену
Программный доступ к интерфейсам (через API-токен).
Публичный доступ
Публичные интерфейсы по токену.
Операции
Всего операций: 34. У каждой операции своя страница со схемами запроса и ответа и примерами вызова.
Управление интерфейсами
| Метод | Путь | Операция |
|---|---|---|
GET | /api/v1/interfaces | Список интерфейсов |
POST | /api/v1/interfaces | Создать интерфейс |
GET | /api/v1/interfaces/pipelines | Пайплайны команды или объекта |
POST | /api/v1/interfaces/pipelines | Создать пайплайн с явным составом |
GET | /api/v1/interfaces/pipelines/candidates | Доступные участники пайплайна |
GET | /api/v1/interfaces/pipelines/{id} | Состав и проверенные связи пайплайна |
PATCH | /api/v1/interfaces/pipelines/{id} | Изменить состав пайплайна с проверкой версии |
GET | /api/v1/interfaces/pipelines/{id}/registry-routing | Настройки передачи ответов формы в реестры |
PUT | /api/v1/interfaces/pipelines/{id}/registry-routing | Сохранить рабочие связи формы с реестрами |
DELETE | /api/v1/interfaces/{id} | Удалить интерфейс |
GET | /api/v1/interfaces/{id} | Получить интерфейс |
PUT | /api/v1/interfaces/{id} | Обновить интерфейс |
POST | /api/v1/interfaces/{id}/action | Выполнить действие интерфейса (согласовать, подписать, сгенерировать, отправить) |
GET | /api/v1/interfaces/{id}/availability | Свободные слоты записи (для предпросмотра) |
POST | /api/v1/interfaces/{id}/duplicate | Дублировать интерфейс |
PATCH | /api/v1/interfaces/{id}/publish/{channel} | Обновить публикацию интерфейса в канал |
POST | /api/v1/interfaces/{id}/publish/{channel}/rotate | Сгенерировать новый токен публикации |
POST | /api/v1/interfaces/{id}/send-telegram | Отправить интерфейс через Telegram |
GET | /api/v1/interfaces/{id}/uploads/{fileId}/download | Скачать загруженный файл |
GET | /api/v1/interfaces/{id}/webhook/secret | Получить секрет подписи вебхука |
POST | /api/v1/interfaces/{id}/webhook/secret | Перевыпустить секрет подписи вебхука |
POST | /api/v1/interfaces/{id}/webhook/test | Отправить тестовый ответ на вебхук |
Доступ по API-токену
| Метод | Путь | Операция |
|---|---|---|
GET | /api/v1/interfaces/api/{token} | Схема интерфейса (API) |
POST | /api/v1/interfaces/api/{token}/submit | Отправить интерфейс (API) |
Публичный доступ
| Метод | Путь | Операция |
|---|---|---|
POST | /api/v1/interfaces/booking/{teamId}/{token}/cancel | Отменить бронь |
POST | /api/v1/interfaces/booking/{teamId}/{token}/reschedule | Перенести бронь |
GET | /api/v1/interfaces/public/{token} | Получить публичный интерфейс |
GET | /api/v1/interfaces/public/{token}/availability | Свободные слоты интерфейса записи |
GET | /api/v1/interfaces/public/{token}/registry/{registryTypeId} | Записи реестра для публичного интерфейса |
GET | /api/v1/interfaces/public/{token}/submission/pdf | PDF сгенерированного документа для текущей сессии отправки |
GET | /api/v1/interfaces/public/{token}/submission/status | Статус сгенерированного документа для текущей сессии отправки |
POST | /api/v1/interfaces/public/{token}/submit | Отправить публичный интерфейс |
GET | /api/v1/interfaces/public/{token}/suggest | Подсказки DaData |
POST | /api/v1/interfaces/public/{token}/upload | Загрузить файл в публичный интерфейс |