Page Comparison

Here you learn how to obtain an API key and what you (or the translation administrator) needs to prepare before you can get started.

Prerequisites in Wordbee Translator / Flex

Each Flex document is a "container" of strings. For example, a Flex document can contain all strings (in any languages) of a software.

The API method below gives you all Flex documents in Wordbee Translator with name, ID, last content change and more. You need the document ID in order to interact with the Flex document.

apps/wbflex/list

Without a Flex document, this API is of no use... So you need to add Flex documents (or containers for your strings) in Wordbee projects.

You can do this manually: Prerequisites in Wordbee Translator / Flex

Or you can do this with the API: apps/wbflex/documents (POST)

These are the most important methods. You start off with an empty Flex container and so you will likely start pushing the first version of strings:

apps/wbflex/documents/{id}/contents/push

In regular intervals, you may want to see if the translation team did any changes. Use the list API to find the last change date of selected or all Flex documents:

apps/wbflex/list

Finally, you will want to pull the latest translations:

apps/wbflex/documents/{id}/contents/pull

You can share the prices you apply with clients through the API. See this page:

Costing / Flex

Enable Below method permits clients to download applicable the prices you configured:

documents/{id}/pricing (GET)

To allow a client to preview cost of a push payload, use below method. A push preview is the same as a push except it does not change any data. Simply make sure to set the includeCost parameter to true.

documents/{id}/contents/push/preview

The client can then decide to proceed with the regular push.

If a preview is not needed or of you want to include the cost with the push result, then set the includeCost property to true with the regular push method:

documents/{id}/contents/push

When pushing your strings you need to format your data in a specific JSON format. You find some examples here:

Push updates - JSON samples

When pushing content you can optionally specify a major and minor version number of your strings. This really is an optional feature.

See the push and pull API methods for more.

You can upload and download files linked to a Flex document. These are files saved in the same project and in the same folder (Prerequisites in Wordbee Translator / Flex)

The API methods are:

Managing attached files / Flex

Up to you to tell us!