Описание API¶
Сервис¶
- GET /api/version¶
Получить текущую версию веб-сервиса
- Коды ответа:
200 OK – Версия веб-сервиса
Проекты¶
- POST /api/projects¶
Создать проект
- Коды ответа:
200 OK – Статус результата
401 Unauthorized – Ошибка аутентификации
- GET /api/projects¶
Список проектов пользователя
- Коды ответа:
200 OK – Список проектов
401 Unauthorized – Ошибка аутентификации
- GET /api/projects/{id}¶
Получить данные проекта по идентификатору
- Параметры:
id (string) – Идентификатор проекта
- Параметры запроса:
format (string) – Идентификатор формата
- Коды ответа:
200 OK – Данные проекта
401 Unauthorized – Ошибка аутентификации
- PUT /api/projects/{id}¶
Копировать проект
- Параметры:
id (string) – Идентификатор проекта
- Коды ответа:
200 OK – Статус результата
401 Unauthorized – Ошибка аутентификации
- DELETE /api/projects/{id}¶
Удалить проект
- Параметры:
id (string) – Идентификатор проекта
- Коды ответа:
200 OK – Статус результата
401 Unauthorized – Ошибка аутентификации
- GET /api/projects/export/formats¶
Получить список поддерживаемых форматов для экспорта
- Коды ответа:
200 OK – Список идентификаторов форматов
401 Unauthorized – Ошибка аутентификации
- POST /api/projects/import?format=¶
Импортировать проект
- Тело запроса:
file (binary) – Файл (Обязательно)
- Параметры запроса:
format (string) – Идентификатор формата (Обязательно)
- Коды ответа:
200 OK – Идентификатор созданного проекта
401 Unauthorized – Ошибка аутентификации
- GET /api/projects/import/formats¶
Получить список поддерживаемых форматов для импорта
- Коды ответа:
200 OK – Список идентификаторов форматов
401 Unauthorized – Ошибка аутентификации
Дополнения¶
- GET /api/addons/download/{id}¶
Загрузить дополнение по идентификатору
- Параметры:
id (string) – Идентификатор дополнения
- Коды ответа:
200 OK – Файл дополнения
401 Unauthorized – Ошибка аутентификации
404 Not Found – Элемент не найден
- GET /api/addons/list¶
Получить список доступных дополнений
- Коды ответа:
200 OK – Список идентификаторов дополнений
401 Unauthorized – Ошибка аутентификации
- GET /api/addons/version/{id}¶
Получить текущую версию дополнения
- Параметры:
id (string) – Идентификатор дополнения
- Коды ответа:
200 OK – Версия дополнения
404 Not Found – Элемент не найден