This chapter describes all API methods to interact with the Wordbee Instant Translation tool.
Connection parameters
To use the Instant Translation API you must set the "domain" query parameter to "InstantTranslation" when creating a connection.
Also see API - Connect.
API methods
The instant translation specific methods are:
Connection results
Upon connection, the JSON result includes important configuration details, such as:
{ ... "InstantTranslation": { "urlTerms": null, "deadlineMandatory": true, "deadlineMinLeadHours": 12 } }
The properties are:
InstantTranslation | This node contains the configuration of the tool. |
urlTerms | Applies to post edit requests. If not null then this is the URL to view usage Terms & Conditions. Before a user requests a post edit of a machine translated file, the user must be asked to navigate to this URL. For example, in your user interface you would add a checkbox like: [ ] I have read and agree with the Terms & Conditions. If the property is null then the user does not need to accept any terms and conditions. |
deadlineMandatory | Applies to post edit requests. If not null then the user must choose a deadline for the work. If null then the choice of a deadline is optional. |
deadlineMinLeadHours | Applies to post edit requests. If not null: If the user selects a deadline it must be at least this number of hours into the future. If null: The deadline can be any future date/time, |