Preskočiť na obsah

Projekty, značky a zdieľanie

Knižnica súborov je zdrojom pravdy pre zdroje; projekty, značky a vyhľadávanie sú zobrazenia, ktoré ich organizujú. Zachovajte ID súborov alebo dokumentov; nepoužívajte názvy namiesto stabilných identifikátorov.

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}

Pridanie dokumentu do projektu zmení iba spôsob jeho organizácie: súbor sa nekopíruje a jeho vlastník sa nemení.

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}

Názov značky slúži na zobrazenie; pri mazaní, odpojení a dotazovaní sa používa ID značky.

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

Vyhľadávanie vráti iba dokumenty a úlohy, ktoré si aktuálny účet môže prečítať. Vyhľadávanie je čítacou operáciou a nestojí žiadne kredity.

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 vytvorí odkaz na výsledok prekladu len na čítanie; telo obsahuje artifact_id a voliteľný expires_in_days (1–365; bez neho odkaz nevyprší). Každý, kto má tento odkaz, môže súbor stiahnuť, preto ho uchovávajte mimo protokolov a analytických parametrov a odstráňte ho, keď už nie je potrebný.

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

Tieto koncové body slúžia na vytvorenie jednotného pracovného priestoru pre účet OmniDoc. Klienti by mali používať hodnoty a funkcie uvedené v odpovediach a nemali by si sami vytvárať URL adresy aplikácií.