To separate different services and its data our APIs are served by separated APIs.
E.g. the Base-API serves endpoints for managing a users orders, invoices and user data. The authentication service serves endpoints to for the sign ins, managin access tokens or changing a users password. The file service is the only service that handles documents and therefore serves endpoints for up- and downloading documents.
Use the v2/sign_in endpoint from the Authentication Service to sign in the user.
POST https://auth.toptranslation.com/v2/sign_inThe endpoint will return an access token that you can you use to authenticate against the Base-API. See "Sign in" in the authentication service api for more details.
Use the file service API to upload a document you want to translate to the file service.
POST https://files.toptranslation.com/v2/documentsThe endpoint answers with a token for each document. This token will later be used to add the document to an order. See "Upload a document" in the file service api for more details.
Use the Base API to create an empty order and add meta-data like a briefing or the desired delivery date.
POST https://api.toptranslation.com/v2/ordersThe endpoint answers with an order object that includes the identifier for the order. See "Create an order" in the base api for more details.
Use the token that was returned from the file service in step 2 to identify the uploaded document for this request.
POST https://api.toptranslation.com/v2/orders/:identifier/documentsSee "Add document to an order" in the base api for more details.
When all documents have been added and the order is ready to be sent to our project managers, the order needs to be marked as requested. This is the sign for the API that the order is now complete and ready to be processed.
PATCH https://api.toptranslation.com/v2/orders/:identifier/requestSee "Request an order" in the base api for more details.
If no frame contract is in place or a quote is required Toptranslation will create a quote that needs to be accepted by the user before translation will begin. The base API servers endpoints to manage the quotes of an order.
List all available quotes for an order.
GET https://api.toptranslation.com/v2/orders/:identifier/quotesSee "List quotes of an order" for more details.
Accept the quote. After this the translators will start the translation process.
POST https://api.toptranslation.com/v2/quotes/:identifier/acceptSee "Accept a quote" for more details.
GET https://api.toptranslation.com/v2/orders/:identifier/documents
The response includes the documents added to the order. The documents include the translations of the document. The attribute
downloadable
shows if a translation can be downloaded.
See
"List documents of an order"
for more details.
To download a translation the base API provides a method to retrieve the download url for a translation. For this use the translation identifier to identify the translation you want to download.
GET https://api.toptranslation.com/v2/translations/:identifier/downloadThe endpoint will return a download link that links to the file service and contains a token that will expire after a given time.
Lexeri is the terminology management solution of Toptranslation. Lexeri comes with a separate API and uses Toptranslations User-API and Document-API services for user information or document up- and download.
You can find the following other resources
You can find information about upcoming scheduled maintenances, current issues or outages of our services on our status page.
We will tweet about new API version and other changes to our services as well as the developer life at Toptranslation.
Creating an application with our APIs will be publically available soon. For now please contact us if you want to create an application and we will be happy to help you out.