Share Document

Back to overview

Endpoint

GET https://api.reporting.cloud/v1/document/share

Returns an encrypted document name that can be used in the ReportingCloud Viewer widget

Request Parameters

Query parameter Value Type Value
templateName String The filename of the template in the template storage.

Response Format

On success, the HTTP status code in the response header is OK (200). The response body contains a string that represents the encrypted document name.

A Forbidden (403) is returned, if the user is not authorized.

A Bad Request (400) is returned, if the template doesn't exist in the template storage..

How to use the Viewer widget?

The ReportingCloud Viewer widget is an HTML widget that can be embedded in any website using plain HTML and JavaScript.

Simply copy the following string and add it to your website into any container. The widget is scaled automatically.


Replace the string in the data-document attribute with the return value of this method.

Examples

Note: The code examples available for this method do not represent all supported programming languages.

Try this in the Web API Sandbox

Open Sandbox