Проекты, теги и общий доступ
Библиотека файлов является источником достоверных данных о ресурсах; проекты, теги и поиск — это представления, которые их организуют. Сохраняйте идентификаторы файлов или документов; не используйте названия вместо стабильных идентификаторов.
Проекты
Заголовок раздела «Проекты»GET /api/v1/projectsPOST /api/v1/projectsGET /api/v1/projects/{project_id}PATCH /api/v1/projects/{project_id}DELETE /api/v1/projects/{project_id}
POST /api/v1/projects/{project_id}/documentsDELETE /api/v1/projects/{project_id}/documents/{document_id}Добавление документа в проект изменяет только его организацию: файл не копируется, а его владелец не меняется.
GET /api/v1/tagsPOST /api/v1/tagsDELETE /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/sharesPOST /api/v1/sharesGET /api/v1/shares/{token}GET /api/v1/shares/{token}/downloadDELETE /api/v1/shares/{token}POST /shares создаёт ссылку только для чтения на результат перевода; в теле содержится artifact_id и необязательный expires_in_days (от 1 до 365 дней; при отсутствии этого параметра ссылка не истекает). Любой, у кого есть эта ссылка, может её скачать, поэтому не включайте её в логи и параметры аналитики и удаляйте, когда она больше не понадобится.
Рабочее пространство приложения
Заголовок раздела «Рабочее пространство приложения»GET /api/v1/workspace/filesGET /api/v1/workspace/entriesGET /api/v1/workspace/appsЭти конечные точки предназначены для создания единого рабочего пространства для учётной записи OmniDoc. Клиентам следует использовать значения и возможности, указанные в ответах, и не формировать URL‑адреса приложений самостоятельно.