Wordbee Flex Workflows

Wordbee Flex is a technology to implement continuous translation workflows. Wordbee Flex is perfect when the content you translate constantly changes over longer periods of time, it may grow with more segments added or even shrink sometimes. For example, the strings of software may change with each new software version or build. Developers may push content changes on a daily basis! Our goal with "Flex" is to enable continuous content production, translation and delivery workflows. We definitely do not want new translation jobs with each change. We definitely want the whole process to be as agile as possible for both developers or content producers as well as for translation teams.


These are the topics for you as an API developer:

Topic

Details

Tasks in Wordbee Translator

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


Enumerate existing Flex documents

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


Create new Flex documents

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)


Push and pull content

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


JSON format when pushing content

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

Push updates - JSON samples


Versioning

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.


Attaching reference material

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


What else?

Up to you to tell us!