If the API changes in an incompatible manner this is listed explicitly in the "important release notes" section of each releases changelog.
The 'Globalese' pretranslation is triggered automatically on the translate5 import. The translate5 import will finish and the task will be available for usage after the Globalese pretranslation is done(the translated files are downloaded and merged).
Preconditions for the pretranslation to be started are:
- The Globalese Plug-In must be active
- the Globalese parameters must be sent to the server.
Save the 'Globalese' project parameters for later usage
| URL: | editor/plugins_globalesepretranslation_globalese |
| Available Methods: | POST |
| Specialities: | The passed parameters will be saved internally, the 'Globalese' pretranslation process is triggered by event (importWorkerQueued) from the import workflow (task::post) |
POST request parameters example(json):
{
"engine":"globalese engine id",
"group":"globalese group id",
"apiUsername":"globalese username",
"apiKey":"globalese api-key"
}
POST request layout
| Name | Type | Info |
|---|---|---|
engine | int | The id of the globalese engine |
group | int | The id of the globalese group |
apiUsername | string | The username used for globalese api authentication |
apiKey | string | The apiKey used for globalese api authentication |
Provides a list with all available groups.
| URL: | editor/plugins_globalesepretranslation_globalese/groups |
| Available Methods: | GET |
Specialities: | - |
GET request parameters example (json):
{
"username":"globalese username",
"apiKey":"globalese api-key"
}
Groups request Layout
| Name | Type | Info |
|---|---|---|
username | string | The username used for globalese api authentication |
apiKey | string | The apiKey used for globalese api authentication |
Groups response Layout
| Name | Type | Info |
|---|---|---|
| id | integer | The id of the group |
| name | string | The name of the group |
Additional info: Only the groups who exist for the authenticated user will be returned.
Provides a list with all available engines.
| URL: | editor/plugins_globalesepretranslation_globalese/engines |
| Available Methods: | GET |
| Specialities: | - |
GET request parameters example (json):
{
"username":"globalese username",
"apiKey":"globalese api-key",
"sourceLang":"5",
"targetLang":"4"
}
Engines request Layout
| Name | Type | Info |
|---|---|---|
username | string | The username used for globalese api authentication |
apiKey | string | The apiKey used for globalese api authentication |
sourceLang | int | Source language id of the engine that will be searched |
targetLang | int | Targed language id of the engine that will be searched |
Engines response Layout
| Name | Type | Info |
|---|---|---|
| source | string (rfc5646) | Source language of the engine |
| target | string (rfc5646) | Target language of the engine |
| group | int | The group id where this engine belongs to |
| id | int | The id of the engine |
| name | string | The name of the engine |
| status | string | The status of the engine ('on' or 'trained') |