Проєкти, теги та спільний доступ
Бібліотека файлів є основним джерелом інформації про ресурси; проєкти, теги та пошук — це способи їх організації. Зберігайте ідентифікатори файлів або документів; не використовуйте назви замість стабільних ідентифікаторів.
Проєкти
Section titled “Проєкти”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Пошук повертає лише документи та завдання, які поточний обліковий запис може читати. Пошук є операцією читання і не споживає кредити.
Поділитися посиланнями
Section titled “Поділитися посиланнями”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; без цього посилання не має терміну дії). Будь-хто, хто має це посилання, може завантажити файл, тому тримайте його поза логами та параметрами аналітики, а також видаляйте, коли воно більше не потрібне.
Робоче простір додатка
Section titled “Робоче простір додатка”GET /api/v1/workspace/filesGET /api/v1/workspace/entriesGET /api/v1/workspace/appsЦі кінцеві точки призначені для створення єдиного робочого простору для облікового запису OmniDoc. Клієнти повинні дотримуватися вказівок та можливостей, наведених у відповідях, і не повинні самостійно формувати URL-адреси програм.