Перейти к содержимому

Проекты, теги и общий доступ

Библиотека файлов является источником достоверных данных о ресурсах; проекты, теги и поиск — это представления, которые их организуют. Сохраняйте идентификаторы файлов или документов; не используйте названия вместо стабильных идентификаторов.

GET /api/v1/projects
POST /api/v1/projects
GET /api/v1/projects/{project_id}
PATCH /api/v1/projects/{project_id}
DELETE /api/v1/projects/{project_id}
POST /api/v1/projects/{project_id}/documents
DELETE /api/v1/projects/{project_id}/documents/{document_id}

Добавление документа в проект изменяет только его организацию: файл не копируется, а его владелец не меняется.

GET /api/v1/tags
POST /api/v1/tags
DELETE /api/v1/tags/{tag_id}
POST /api/v1/tags/documents/{document_id}
DELETE /api/v1/tags/documents/{document_id}/{tag_id}

Имя тега предназначено для отображения; при удалении, отсоединении и запросах используется идентификатор тега.

GET /api/v1/search?q={query}&limit=20

Поиск возвращает только документы и задания, которые текущая учётная запись может читать. Поиск является операцией чтения и не тратит кредиты.

GET /api/v1/shares
POST /api/v1/shares
GET /api/v1/shares/{token}
GET /api/v1/shares/{token}/download
DELETE /api/v1/shares/{token}

POST /shares создаёт ссылку только для чтения на результат перевода; в теле содержится artifact_id и необязательный expires_in_days (от 1 до 365 дней; при отсутствии этого параметра ссылка не истекает). Любой, у кого есть эта ссылка, может её скачать, поэтому не включайте её в логи и параметры аналитики и удаляйте, когда она больше не понадобится.

GET /api/v1/workspace/files
GET /api/v1/workspace/entries
GET /api/v1/workspace/apps

Эти конечные точки предназначены для создания единого рабочего пространства для учётной записи OmniDoc. Клиентам следует использовать значения и возможности, указанные в ответах, и не формировать URL‑адреса приложений самостоятельно.