+49 40 6094641 30
API documentation
Our API documentation helps you get started with development using our API and describes all the functions of the Toptranslation API in detail.
individual programming
Interface (API)
All translation processes should be as simple as possible for our customers. We are therefore constantly developing new technical solutions.
Would you like to internationalize your company website or operate your e-shop in several countries? You can transfer text content directly and easily from your content management system - or any other application - to our system via our REST API (programming interface). You can order a new translation with just one click and the translations are returned to your system just as easily thanks to webhooks. And in the right format for your program. This makes it easy for you to manage large translation jobs, as applications such as content management systems, ERP or e-shops can be easily connected to our API. The big plus for you: You always have an overview of the current order status and can follow each individual work step.
Individual solutions for your needs
On request, our technical team will work with you to develop a specific plug-in to connect your system to the API. The tedious transfer of data by e-mail and the manual import and export of individual documents is no longer necessary. Sources of error are significantly reduced and you save time. You can use your user account from another website or from a mobile device via the API. Manage your translation jobs conveniently from your user interface.
REST API
The Toptranslation API follows the REST paradigm and provides responses in JSON notation. The requests are made in the form of HTTP requests, which are secured via SSL.
Authentication
A token is transmitted with each request as authentication; an OAuth workflow for authentication is being planned.
Webhooks
The Toptranslation API can inform customers' systems via webhooks about completed deliveries, changes in order status or other activities. The target URL of webhooks can be freely defined. The request of a webhook transmits information on the project status or the completed translation in JSON notation.
File server
Documents and data are kept separate in the Toptranslation systems for security reasons. Documents are exchanged via the Toptranslation file server DocumentStore. A detailed description of the DocumentStore API is provided by Toptranslation in the developer portal: developer.toptranslation.com
Plug-ins and integrations
Toptranslation can offer plug-ins or integrations for various content management systems that can be used to transfer content from the customer's CMS to the Toptranslation API. Individual solutions can be developed through top translation on request.
Resources to be managed via API
The following translation management resources can be managed via the Toptranslation API:
- Translation orders
- Translated documents
- Reference documents (translation memories, glossaries, style guides, etc.)
- Cost centers
- Teams
- Offers
- Invoices
Translation workflow with the Toptranslation API
- Create a translation job: information such as the desired delivery date, the cost center, a briefing, an internal project name or reference or a service level can be specified via the API.
- Transfer of the documents to be translated: Documents are uploaded to the file server via HTTP requests and added to the translation job using an API endpoint. The required language combinations are transferred here.
- Quotation generation through top translation (optional): if desired, Toptranslation will create a quote and make it available via the API. The customer's system can be informed of the creation of an offer via webhook or e-mail.
- Accept the offer (optional): the offer provided by Toptranslation can be accepted or rejected via the API.
- Start of the translation process: the Toptranslation API informs the customer's system about status changes via webhooks.
- Retrieve the current translation status (optional): the customer's system can query the current status of the project and the percentage of progress at any time via the Toptranslation API.
- Provision of translated documents: the Toptranslation API informs the customer's system via webhooks when a translated document is available. This can then be downloaded via the file server using an HTTP request.
- Invoicing: the Toptranslation API can be used to retrieve the invoices for a translation job and download the documents as a PDF from the file server.
