Progetti, tag e condivisione
La libreria dei file è la fonte unica di verità per le risorse; progetti, tag e ricerca sono visualizzazioni che le organizzano. Conservare gli ID dei file o dei documenti; non utilizzare i nomi al posto di identificatori stabili.
Progetti
Sezione intitolata “Progetti”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}L’aggiunta di un documento a un progetto modifica solo la sua organizzazione: il file non viene copiato e il suo proprietario rimane invariato.
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}Il nome del tag è destinato alla visualizzazione; l’eliminazione, il distacco e le query utilizzano l’ID del tag.
Ricerca
Sezione intitolata “Ricerca”GET /api/v1/search?q={query}&limit=20La ricerca restituisce solo documenti e job che l’account corrente può leggere. La ricerca è un’operazione di lettura e non consuma crediti.
Condividi link
Sezione intitolata “Condividi link”GET /api/v1/sharesPOST /api/v1/sharesGET /api/v1/shares/{token}GET /api/v1/shares/{token}/downloadDELETE /api/v1/shares/{token}POST /shares crea un link di sola lettura verso un risultato di traduzione; il corpo contiene artifact_id e un expires_in_days facoltativo (da 1 a 365; in sua assenza il link non scade). Chiunque disponga del link può effettuare il download, pertanto evitare di includerlo nei log o nei parametri di analisi e eliminarlo quando non è più necessario.
Spazio di lavoro dell’app
Sezione intitolata “Spazio di lavoro dell’app”GET /api/v1/workspace/filesGET /api/v1/workspace/entriesGET /api/v1/workspace/appsQuesti endpoint sono destinati alla creazione di un workspace unificato per un account OmniDoc. I client dovrebbero fare riferimento alle voci e alle funzionalità riportate nelle risposte, evitando di generare autonomamente gli URL delle applicazioni.