Docs for the asset API

Signed-off-by: Roeland Jago Douma <roeland@famdouma.nl>
This commit is contained in:
Roeland Jago Douma 2018-08-16 14:08:51 +02:00
commit 108752cc74
No known key found for this signature in database
GPG key ID: F941078878347C0C

30
docs/asset_api.md Normal file
View file

@ -0,0 +1,30 @@
# Assets API
This api is used to insert files directly from your Nextcloud to a collabora
document.
## Creating the asset
```
<sever>/apps/richdocuments/assets
```
A `POST` request to this endpoint with the `path` parameter will
prepare the asset as `path` (relateive to the authenticated user).
The return is json:
```json
{
url: <assetUrl>
}
```
The `assetUrl` has to be send to the collabora server using the
postMessage API.
## Fetching an asset
An asset can be fetched once from the url obtained when creating the asset.
The asset will be served with a proper `Content-Type`.