Welcome to the Tansa API specifications.
There are three different Tansa APIs that support different methods of adding the Tansa
proofing service to a text editing environment: JavaScript, Service and REST.
Please read the description below all three before moving on to the selected specification,
to ensure you've selected the Tansa API that best fits your needs. The fourth API,
Fitness Status, can be used to check up on the health and fitness of your Tansa system.
This Tansa API is designed for use in web applications and pages.
This API is the fastest and simplest to implement, as it only requires copying a ready-made JS
function into your pages(s) and hooking that up to a button, menu item or event — and Tansa
will take it from there.
This Tansa API is typically used when implementing Tansa in native desktop applications.
The main requirement is that you are able to render Tansa's web UI in a browser control
within the application. You communicate with Tansa using GET and POST requests,
and Tansa responds with a complete functional web UI filled with data, according to
submitted parameters.
The Tansa REST API is designed to give the Tansa implementer the greatest flexibility,
in cases where the JS API and the Service API won't fit. We strongly recommend one of
the two other APIs, but if you either need to create a different kind of Tansa Client,
or you need to create a different kind of Tansa service than what the Tansa Client
provides, then the Tansa REST API might be what you need. If your solution requires
a UI, you will need to build and maintain that.
The Tansa Fitness Status API provides health and performance data on your Tansa system,
both overall and individually on each proofing option. Critical issues will be described
in detail in the response. It's intended use is to be included in an automated monitoring
service.
