跳转到内容

Projekti, oznake i dijeljenje

Biblioteka datoteka je izvorište podataka o resursima; projekti, oznake i pretraživanje su prikazi koji ih organiziraju. Čuvajte ID-e datoteka ili dokumenata; ne koristite nazive umjesto stabilnih identifikatora.

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}

Dodavanje dokumenta projektu samo mijenja način njegove organizacije: datoteka se ne kopira i njen vlasnik se ne mijenja.

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}

Ime oznake služi za prikaz; brisanje, odvajanje i upit koriste ID oznake.

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

Pretraživanje vraća samo dokumente i zadatke koje trenutni račun može čitati. Pretraživanje je operacija čitanja i ne troši kredite.

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 stvara poveznicu samo za čitanje na rezultat prijevoda; tijelo sadrži artifact_id i opcionalni expires_in_days (1–365; bez njega poveznica ne istječe). Svatko tko ima tu poveznicu može je preuzeti, stoga ju držite izvan logova i parametara analitike te izbrišite kada više nije potrebna.

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

Ove točke pristupa služe za izgradnju jedinstvenog radnog prostora za račun OmniDoc. Klijenti trebaju slijediti unose i mogućnosti u odgovorima te ne smiju samostalno kreirati URL-ove aplikacija.