# Интерфейсы

> REST API раздела «Интерфейсы»: 34 операции.

Базовый адрес: `https://api.legalstack.ru`. Спецификация: [openapi/interfaces.json](https://docs.legalstack.ru/openapi/interfaces.json).

- [Управление интерфейсами](https://docs.legalstack.ru/api/interfaces/interfaces): Формы для сбора данных.
- [Доступ по API-токену](https://docs.legalstack.ru/api/interfaces/interfaces-api): Программный доступ к интерфейсам (через API-токен).
- [Публичный доступ](https://docs.legalstack.ru/api/interfaces/interfaces-public): Публичные интерфейсы по токену.

## Операции

Всего операций: 34. У каждой операции своя страница со схемами запроса и ответа и примерами вызова.

### [Управление интерфейсами](https://docs.legalstack.ru/api/interfaces/interfaces)

| Метод | Путь | Операция |
| --- | --- | --- |
| `GET` | `/api/v1/interfaces` | [Список интерфейсов](https://docs.legalstack.ru/api/interfaces/interfaces/get-interfaces) |
| `POST` | `/api/v1/interfaces` | [Создать интерфейс](https://docs.legalstack.ru/api/interfaces/interfaces/post-interfaces) |
| `GET` | `/api/v1/interfaces/pipelines` | [Пайплайны команды или объекта](https://docs.legalstack.ru/api/interfaces/interfaces/get-interfaces-pipelines) |
| `POST` | `/api/v1/interfaces/pipelines` | [Создать пайплайн с явным составом](https://docs.legalstack.ru/api/interfaces/interfaces/post-interfaces-pipelines) |
| `GET` | `/api/v1/interfaces/pipelines/candidates` | [Доступные участники пайплайна](https://docs.legalstack.ru/api/interfaces/interfaces/get-interfaces-pipelines-candidates) |
| `GET` | `/api/v1/interfaces/pipelines/{id}` | [Состав и проверенные связи пайплайна](https://docs.legalstack.ru/api/interfaces/interfaces/get-interfaces-pipelines-id) |
| `PATCH` | `/api/v1/interfaces/pipelines/{id}` | [Изменить состав пайплайна с проверкой версии](https://docs.legalstack.ru/api/interfaces/interfaces/patch-interfaces-pipelines-id) |
| `GET` | `/api/v1/interfaces/pipelines/{id}/registry-routing` | [Настройки передачи ответов формы в реестры](https://docs.legalstack.ru/api/interfaces/interfaces/get-interfaces-pipelines-id-registry-routing) |
| `PUT` | `/api/v1/interfaces/pipelines/{id}/registry-routing` | [Сохранить рабочие связи формы с реестрами](https://docs.legalstack.ru/api/interfaces/interfaces/put-interfaces-pipelines-id-registry-routing) |
| `DELETE` | `/api/v1/interfaces/{id}` | [Удалить интерфейс](https://docs.legalstack.ru/api/interfaces/interfaces/delete-interfaces-id) |
| `GET` | `/api/v1/interfaces/{id}` | [Получить интерфейс](https://docs.legalstack.ru/api/interfaces/interfaces/get-interfaces-id) |
| `PUT` | `/api/v1/interfaces/{id}` | [Обновить интерфейс](https://docs.legalstack.ru/api/interfaces/interfaces/put-interfaces-id) |
| `POST` | `/api/v1/interfaces/{id}/action` | [Выполнить действие интерфейса (согласовать, подписать, сгенерировать, отправить)](https://docs.legalstack.ru/api/interfaces/interfaces/post-interfaces-id-action) |
| `GET` | `/api/v1/interfaces/{id}/availability` | [Свободные слоты записи (для предпросмотра)](https://docs.legalstack.ru/api/interfaces/interfaces/get-interfaces-id-availability) |
| `POST` | `/api/v1/interfaces/{id}/duplicate` | [Дублировать интерфейс](https://docs.legalstack.ru/api/interfaces/interfaces/post-interfaces-id-duplicate) |
| `PATCH` | `/api/v1/interfaces/{id}/publish/{channel}` | [Обновить публикацию интерфейса в канал](https://docs.legalstack.ru/api/interfaces/interfaces/patch-interfaces-id-publish-channel) |
| `POST` | `/api/v1/interfaces/{id}/publish/{channel}/rotate` | [Сгенерировать новый токен публикации](https://docs.legalstack.ru/api/interfaces/interfaces/post-interfaces-id-publish-channel-rotate) |
| `POST` | `/api/v1/interfaces/{id}/send-telegram` | [Отправить интерфейс через Telegram](https://docs.legalstack.ru/api/interfaces/interfaces/post-interfaces-id-send-telegram) |
| `GET` | `/api/v1/interfaces/{id}/uploads/{fileId}/download` | [Скачать загруженный файл](https://docs.legalstack.ru/api/interfaces/interfaces/get-interfaces-id-uploads-fileid-download) |
| `GET` | `/api/v1/interfaces/{id}/webhook/secret` | [Получить секрет подписи вебхука](https://docs.legalstack.ru/api/interfaces/interfaces/get-interfaces-id-webhook-secret) |
| `POST` | `/api/v1/interfaces/{id}/webhook/secret` | [Перевыпустить секрет подписи вебхука](https://docs.legalstack.ru/api/interfaces/interfaces/post-interfaces-id-webhook-secret) |
| `POST` | `/api/v1/interfaces/{id}/webhook/test` | [Отправить тестовый ответ на вебхук](https://docs.legalstack.ru/api/interfaces/interfaces/post-interfaces-id-webhook-test) |

### [Доступ по API-токену](https://docs.legalstack.ru/api/interfaces/interfaces-api)

| Метод | Путь | Операция |
| --- | --- | --- |
| `GET` | `/api/v1/interfaces/api/{token}` | [Схема интерфейса (API)](https://docs.legalstack.ru/api/interfaces/interfaces-api/get-interfaces-api-token) |
| `POST` | `/api/v1/interfaces/api/{token}/submit` | [Отправить интерфейс (API)](https://docs.legalstack.ru/api/interfaces/interfaces-api/post-interfaces-api-token-submit) |

### [Публичный доступ](https://docs.legalstack.ru/api/interfaces/interfaces-public)

| Метод | Путь | Операция |
| --- | --- | --- |
| `POST` | `/api/v1/interfaces/booking/{teamId}/{token}/cancel` | [Отменить бронь](https://docs.legalstack.ru/api/interfaces/interfaces-public/post-interfaces-booking-teamid-token-cancel) |
| `POST` | `/api/v1/interfaces/booking/{teamId}/{token}/reschedule` | [Перенести бронь](https://docs.legalstack.ru/api/interfaces/interfaces-public/post-interfaces-booking-teamid-token-reschedule) |
| `GET` | `/api/v1/interfaces/public/{token}` | [Получить публичный интерфейс](https://docs.legalstack.ru/api/interfaces/interfaces-public/get-interfaces-public-token) |
| `GET` | `/api/v1/interfaces/public/{token}/availability` | [Свободные слоты интерфейса записи](https://docs.legalstack.ru/api/interfaces/interfaces-public/get-interfaces-public-token-availability) |
| `GET` | `/api/v1/interfaces/public/{token}/registry/{registryTypeId}` | [Записи реестра для публичного интерфейса](https://docs.legalstack.ru/api/interfaces/interfaces-public/get-interfaces-public-token-registry-registrytypeid) |
| `GET` | `/api/v1/interfaces/public/{token}/submission/pdf` | [PDF сгенерированного документа для текущей сессии отправки](https://docs.legalstack.ru/api/interfaces/interfaces-public/get-interfaces-public-token-submission-pdf) |
| `GET` | `/api/v1/interfaces/public/{token}/submission/status` | [Статус сгенерированного документа для текущей сессии отправки](https://docs.legalstack.ru/api/interfaces/interfaces-public/get-interfaces-public-token-submission-status) |
| `POST` | `/api/v1/interfaces/public/{token}/submit` | [Отправить публичный интерфейс](https://docs.legalstack.ru/api/interfaces/interfaces-public/post-interfaces-public-token-submit) |
| `GET` | `/api/v1/interfaces/public/{token}/suggest` | [Подсказки DaData](https://docs.legalstack.ru/api/interfaces/interfaces-public/get-interfaces-public-token-suggest) |
| `POST` | `/api/v1/interfaces/public/{token}/upload` | [Загрузить файл в публичный интерфейс](https://docs.legalstack.ru/api/interfaces/interfaces-public/post-interfaces-public-token-upload) |