API Reference
When you know what you want DS Server to do and need the exact endpoint, class or member, look it up in the API Reference. It documents the three ways your code talks to DS Server: the HTTP endpoints of the Web API, the .NET packages that call them from C# and the JavaScript objects that control the Document Editor and the Document Viewer in the browser.
The guide pages of this documentation explain the tasks and link the endpoints and members they use to their pages here. Use the reference to check a parameter, a request body, a status code or the members of a class.
What the Reference Covers
| Part | What it documents | Where the code runs |
|---|---|---|
| Web API | The public endpoints of DS Server, grouped as DocumentProcessing, OAuth, Administration, Licensing and Authentication Server, with their requests, responses and errors | Any application that sends HTTP requests |
| .NET API | The NuGet packages TXTextControl.DocumentServices.DocumentProcessing, TXTextControl.DocumentServices.Admin and TXTextControl.DocumentServices.Plugin.Abstractions | In your .NET application, or inside DS Server as a plugin |
| JavaScript API | The TXTextControl object of the Document Editor and the TXDocumentViewer object of the Document Viewer | In the browser |
The settings of the ASP.NET Core, Angular and React components are listed on their pages in Client-Side Libraries.
The Web API
The Web API is the foundation: the client libraries, the components and your own HTTP requests all use it. Its five groups are:
- DocumentProcessing: 16 endpoints below
/documentprocessing/that convert, merge, append, search and replace, inspect and render documents, create and read PDF documents and create barcodes. - OAuth:
/oauth/authorizeand/oauth/token, which issue the access tokens that the other endpoints require when OAuth is enabled, and/oauth/validatetokenand/oauth/test, which check a token. - Administration: the endpoints below
/admin/that change the admin password, manage security profiles and authentication servers, and switch OAuth on or off. - Licensing: the endpoints below
/license/that register the server online or offline, renew or remove its license, validate a serial number and create a license request string. - Authentication Server: the endpoints below
/authenticationserver/that issue tokens like the OAuth endpoints, but never forward a request to other authentication servers.
Most endpoint pages show a curl request and its response, so that you can try a call before writing code.
Find the Right Page
| If you want to | Read |
|---|---|
| Send a document to DS Server and get a PDF back | POST /documentprocessing/document/convert |
| Merge a template with JSON data | POST /documentprocessing/document/merge |
| Request an access token | POST /oauth/token |
| Create security profiles from a script | Administration |
| Find the C# method for an endpoint | .NET API |
| Call the Document Editor or the Document Viewer from JavaScript | JavaScript API |
| Learn a task before looking up its endpoint | Document Processing |
Pages in This Section
- Web API: the HTTP endpoints of DS Server.
- .NET API: the .NET packages for DocumentProcessing, administration and plugins.
- JavaScript API: the browser APIs of the Document Editor and the Document Viewer.