API Reference
Everything your application asks of ReportingCloud is a request to its Web API, and the API Reference describes each of those requests in full: the URL and HTTP method, the query parameters, the JSON objects of the request and the response, the status codes and the quota a request counts against. It also points to the API documentation of the four SDKs, which wrap the same requests in classes for .NET, PHP, Java and Ruby.
The guide pages explain the tasks and link to the endpoints they use. Come here when you need the exact name of a parameter, the formats an endpoint accepts or returns, or the meaning of an error response.
What the Reference Covers
| Part | What it documents | Where it is |
|---|---|---|
| Web API | The 25 methods of the endpoints below https://api.reporting.cloud/v1/, in six groups, with their parameters, payloads, responses, errors and examples | This documentation |
| SDK API documentation | The classes and methods of the .NET, PHP, Java and Ruby SDKs | Published by Text Control on GitHub Pages |
The Web API
The Web API is what every client of ReportingCloud calls, whether it sends HTTP requests itself or uses an SDK. Requests and responses are JSON, and templates and documents travel in them as Base64 strings. Its six groups are:
- Document: the endpoints below
/v1/documentthat merge templates with JSON data, append, convert and search and replace documents, render document pages as images and share a stored template for the viewer widget of ReportingCloud. - Templates: the endpoints below
/v1/templatesthat upload, list, count, download and delete the templates in the template storage, check whether one exists and return a template's merge fields, merge blocks, page count and page images. - Account: the endpoints below
/v1/accountthat create, list and delete API keys and return the quotas of the account and how much of them is used. - Fonts:
/v1/fonts/list, which returns the fonts a template can use. - Proofing: the endpoints below
/v1/proofingthat check the spelling of text, suggest corrections and list the dictionaries. - Processing: the endpoints below
/v1/processingthat list the tracked changes of a document and accept or reject one of them.
Every method page shows the request as a curl command and the same call in C# and PHP, and in Java and Ruby where those SDKs have a method for it.
SDK API Documentation
Each SDK has its own API documentation, generated from its source code and published outside this site. In every SDK, an instance of the class ReportingCloud sends the requests.
| SDK | Package | Main class | API documentation |
|---|---|---|---|
| .NET | TXTextControl.ReportingCloud on NuGet | TXTextControl.ReportingCloud.ReportingCloud | ReportingCloud .NET Wrapper API Documentation |
| PHP | textcontrol/textcontrol-reportingcloud on Packagist | TextControl\ReportingCloud\ReportingCloud | ReportingCloud PHP SDK API documentation |
| Java | None; built from the source on GitHub | com.textcontrol.reportingcloud.ReportingCloud | ReportingCloud Java SDK Javadoc |
| Ruby | txtextcontrol-reportingcloud on RubyGems | TXTextControl::ReportingCloud::ReportingCloud | ReportingCloud Ruby SDK YARD documentation |
The SDKs do not cover the same endpoints: the Java and Ruby SDKs have no methods for document thumbnails, sharing and tracked changes, and the PHP SDK has none for sharing. The group pages of the Web API name the SDK methods that call their endpoints, and SDKs compares the SDKs and shows how to use them.
Find the Right Page
| If you want to | Read |
|---|---|
| Merge a template with JSON data | POST /v1/document/merge |
| Learn how templates and data become documents before you look up the endpoint | Mail Merge |
| Convert a document to PDF or another format | POST /v1/document/convert |
| Store a template so that a merge request only names it | POST /v1/templates/upload |
| Find the merge fields and merge blocks of a template | GET /v1/templates/info |
| See how many documents your account created this month | GET /v1/account/settings |
Build the Authorization header of a request | Authentication |
| Understand a 400 or 403 response | Errors and Status Codes |
| Learn a task other than merging, such as appending, thumbnails or spell checking | Document Processing |
| Look up a class or method of an SDK | SDK API Documentation |
Pages in This Section
- Web API: the base URL, every method of the Web API in one table, authentication and quotas, and the six groups of endpoints.