diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/asset_api.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/asset_api.md b/docs/asset_api.md new file mode 100644 index 00000000..6ec308a9 --- /dev/null +++ b/docs/asset_api.md @@ -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`. + |