Web API Endpoint Reference

Our Web API endpoints enable developers to manage templates and to create documents.

Web API Base URL: https://api.reporting.cloud

Method Endpoint Usage Returns Authentication
GET
/v1/templates/list Lists all templates from the template storage Array of ReportingCloud TemplateList objects Basic
GET
/v1/templates/info Returns information about the template including merge fields and merge blocks TemplateInfo object Basic
GET
/v1/templates/thumbnails Creates and returns thumbnail images of template pages Array of Base64 encoded PNGs Basic
GET
/v1/templates/count Returns the number of templates in the template storage Number (Integer) Basic
GET
/v1/templates/download Returns the selected template from the storage Base64 encoded string Basic
DELETE
/v1/templates/delete Deletes a template from the template storage Basic
GET
/v1/templates/pagecount Returns the number of pages of a template in the template storage Number (Long) Basic
GET
/v1/templates/exists Checks whether a template exists in the template storage Basic
POST
/v1/templates/upload Stores an uploaded template in the template storage (*.doc, *.docx, *.rtf and *.tx) Basic
POST
/v1/document/merge Merges and returns a template from the template storage or an uploaded template with JSON data Array of Base64 encoded strings Basic
POST
/v1/document/convert Converts a document to another format Base64 encoded string Basic
POST
/v1/document/findandreplace Executes a find and replace on a template Base64 encoded string Basic
GET
/v1/account/settings Returns the account settings ReportingCloud Settings object Basic

Authorization

Endpoints marked "Basic" above require a basic user authorization to access user data and templates.

Header field Value
Authorization

Required. A valid ReportingCloud account is required. The Authorization field is constructed as follows:

The username and password are combined into a string separated by a colon, e.g.: username:password

The resulting string is encoded using the RFC2045-MIME variant of Base64, except not limited to 76 char/line.

The authorization method and a space i.e. "Basic " is then put before the encoded string.

Sample: Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l