---
language: "en"
---
# Wordbee Beebox
## Wordbee Beebox
Beebox is a software solution that can help you translate files, documents or content management systems (CMS) in an either automated or manual manner. You can ...
### Documentation
*
#### [Overview](https://help.wordbee.com/beebox/overview.md)
* [Architecture](https://help.wordbee.com/beebox/architecture.md)
*
#### [Features](https://help.wordbee.com/beebox/features.md)
* [Pretranslation](https://help.wordbee.com/beebox/pretranslation.md)
* [Beebox Project](https://help.wordbee.com/beebox/beebox-project.md)
* [Project Types](https://help.wordbee.com/beebox/project-types.md)
* [Translation Process](https://help.wordbee.com/beebox/translation-process.md)
*
#### [User Guide](https://help.wordbee.com/beebox/user-guide.md)
* [Login](https://help.wordbee.com/beebox/login.md)
* [All Projects](https://help.wordbee.com/beebox/all-projects.md)
* [Add Project](https://help.wordbee.com/beebox/add-project.md)
* [View Regular Project](https://help.wordbee.com/beebox/view-regular-project.md)
* [View CMS Project](https://help.wordbee.com/beebox/view-cms-project.md)
* [6 more pages](https://help.wordbee.com/beebox/user-guide.md)
*
#### [Connectors](https://help.wordbee.com/beebox/connectors.md)
* [CMS Connectors](https://help.wordbee.com/beebox/cms-connectors.md)
* [Cloud Storage Connectors](https://help.wordbee.com/beebox/cloud-storage-connectors.md)
* [Software Localization Connectors](https://help.wordbee.com/beebox/software-localization-connectors.md)
* [GIT Localization Connector](https://help.wordbee.com/beebox/git-localization-connector.md)
*
#### [Live Preview](https://help.wordbee.com/beebox/live-preview.md)
* [Live Preview - Example](https://help.wordbee.com/beebox/live-preview-example.md)
* [Live Preview - Setup](https://help.wordbee.com/beebox/live-preview-setup.md)
* [Live Preview - Preview translations](https://help.wordbee.com/beebox/live-preview-preview-translations.md)
* [Live Preview - Proxy server integration](https://help.wordbee.com/beebox/live-preview-proxy-server-integration.md)
* [Live Preview - Troubleshooting](https://help.wordbee.com/beebox/live-preview-troubleshooting.md)
*
#### [Development](https://help.wordbee.com/beebox/development.md)
* [Developer Introduction](https://help.wordbee.com/beebox/developer-introduction.md)
* [File Copy](https://help.wordbee.com/beebox/file-copy.md)
* [Web API](https://help.wordbee.com/beebox/web-api.md)
* [Web Callbacks](https://help.wordbee.com/beebox/web-callbacks.md)
* [Powershell Scripts](https://help.wordbee.com/beebox/powershell-scripts.md)
* [1 more pages](https://help.wordbee.com/beebox/development.md)
*
#### [Q\&A](https://help.wordbee.com/beebox/q-a.md)
* [Q\&A - Where can I get answers?](https://help.wordbee.com/beebox/q-a-where-can-i-get-answers.md)
* [Q\&A - How do I translate a CMS?](https://help.wordbee.com/beebox/q-a-how-do-i-translate-a-cms.md)
* [Q\&A - Can I translate GIT repositories](https://help.wordbee.com/beebox/q-a-can-i-translate-git-repositories.md)
* [Q\&A - Translating Dropbox, Box, OneDrive, Google Drive and others](https://help.wordbee.com/beebox/q-a-translating-dropbox-box-onedrive-google-drive-.md)
* [Q\&A - Pass Through Projects](https://help.wordbee.com/beebox/q-a-pass-through-projects.md)
* [1 more pages](https://help.wordbee.com/beebox/q-a.md)
*
#### [Release History](https://help.wordbee.com/beebox/release-history.md)
* [Releases 2026-08](https://help.wordbee.com/beebox/releases-2026-08.md)
* [Releases 2026-07](https://help.wordbee.com/beebox/releases-2026-07.md)
* [Releases 2026-06](https://help.wordbee.com/beebox/releases-2026-06.md)
* [Releases 2026-05](https://help.wordbee.com/beebox/releases-2026-05.md)
* [Releases 2026-04](https://help.wordbee.com/beebox/releases-2026-04.md)
* [7 more pages](https://help.wordbee.com/beebox/release-history.md)
---
language: "en"
---
# 2017 Releases
This section shows release announcements for the year 2017
* [Releases 2017-06](https://help.wordbee.com/beebox/releases-2017-06.md)
* [Releases 2017-05](https://help.wordbee.com/beebox/releases-2017-05.md)
* [Releases 2017-04](https://help.wordbee.com/beebox/releases-2017-04.md)
* [Releases 2017-03](https://help.wordbee.com/beebox/releases-2017-03.md)
* [Releases 2017-02](https://help.wordbee.com/beebox/releases-2017-02.md)
* [Releases 2017-01](https://help.wordbee.com/beebox/releases-2017-01.md)
---
language: "en"
---
# 2018 Releases
This section shows release announcements for the year 2018
* [Releases 2018-11](https://help.wordbee.com/beebox/releases-2018-11.md)
* [Releases 2018-07](https://help.wordbee.com/beebox/releases-2018-07.md)
---
language: "en"
---
# 2019 Releases
This section shows release announcements for the year 2019
* [Releases 2019-10](https://help.wordbee.com/beebox/releases-2019-10.md)
* [Releases 2019-09](https://help.wordbee.com/beebox/releases-2019-09.md)
* [Releases 2019-02](https://help.wordbee.com/beebox/releases-2019-02.md)
* [Releases 2019-01](https://help.wordbee.com/beebox/releases-2019-01.md)
---
language: "en"
---
# 2020 Releases
This section shows release announcements for the year 2020
* [Releases 2020-12](https://help.wordbee.com/beebox/releases-2020-12.md)
* [Releases 2020-11](https://help.wordbee.com/beebox/releases-2020-11.md)
* [Releases 2020-10](https://help.wordbee.com/beebox/releases-2020-10.md)
* [Releases 2020-09](https://help.wordbee.com/beebox/releases-2020-09.md)
* [Releases 2020-06](https://help.wordbee.com/beebox/releases-2020-06.md)
* [Releases 2020-05](https://help.wordbee.com/beebox/releases-2020-05.md)
* [Releases 2020-04](https://help.wordbee.com/beebox/releases-2020-04.md)
* [Releases 2020-03](https://help.wordbee.com/beebox/releases-2020-03.md)
---
language: "en"
---
# 2021 Releases
This section shows release announcements for the year 2021
* [Releases 2021-12](https://help.wordbee.com/beebox/releases-2021-12.md)
* [Releases 2021-11](https://help.wordbee.com/beebox/releases-2021-11.md)
* [Releases 2021-10](https://help.wordbee.com/beebox/releases-2021-10.md)
* [Releases 2021-09](https://help.wordbee.com/beebox/releases-2021-09.md)
* [Releases 2021-08](https://help.wordbee.com/beebox/releases-2021-08.md)
* [Releases 2021-07](https://help.wordbee.com/beebox/releases-2021-07.md)
* [Releases 2021-06](https://help.wordbee.com/beebox/releases-2021-06.md)
* [Releases 2021-05](https://help.wordbee.com/beebox/releases-2021-05.md)
* [Releases 2021-04](https://help.wordbee.com/beebox/releases-2021-04.md)
* [Releases 2021-03](https://help.wordbee.com/beebox/releases-2021-03.md)
* [Releases 2021-02](https://help.wordbee.com/beebox/releases-2021-02.md)
* [Releases 2021-01](https://help.wordbee.com/beebox/releases-2021-01.md)
---
language: "en"
---
# 2022 Releases
This section shows release announcements for the year 2022
* [Releases 2022-12](https://help.wordbee.com/beebox/releases-2022-12.md)
* [Releases 2022-11](https://help.wordbee.com/beebox/releases-2022-11.md)
* [Releases 2022-10](https://help.wordbee.com/beebox/releases-2022-10.md)
* [Releases 2022-09](https://help.wordbee.com/beebox/releases-2022-09.md)
* [Releases 2022-08](https://help.wordbee.com/beebox/releases-2022-08.md)
* [Releases 2022-07](https://help.wordbee.com/beebox/releases-2022-07.md)
* [Releases 2022-06](https://help.wordbee.com/beebox/releases-2022-06.md)
* [Releases 2022-05](https://help.wordbee.com/beebox/releases-2022-05.md)
* [Releases 2022-04](https://help.wordbee.com/beebox/releases-2022-04.md)
* [Releases 2022-03](https://help.wordbee.com/beebox/releases-2022-03.md)
* [Releases 2022-02](https://help.wordbee.com/beebox/releases-2022-02.md)
* [Releases 2022-01](https://help.wordbee.com/beebox/releases-2022-01.md)
---
language: "en"
---
# 2023 Releases
This section shows release announcements for the year 2023
* [Releases 2023-12](https://help.wordbee.com/beebox/releases-2023-12.md)
* [Releases 2023-11](https://help.wordbee.com/beebox/releases-2023-11.md)
* [Releases 2023-10](https://help.wordbee.com/beebox/releases-2023-10.md)
* [Releases 2023-09](https://help.wordbee.com/beebox/releases-2023-09.md)
* [Releases 2023-08](https://help.wordbee.com/beebox/releases-2023-08.md)
* [Releases 2023-07](https://help.wordbee.com/beebox/releases-2023-07.md)
* [Releases 2023-06](https://help.wordbee.com/beebox/releases-2023-06.md)
* [Releases 2023-05](https://help.wordbee.com/beebox/releases-2023-05.md)
* [Releases 2023-04](https://help.wordbee.com/beebox/releases-2023-04.md)
* [Releases 2023-03](https://help.wordbee.com/beebox/releases-2023-03.md)
* [Releases 2023-02](https://help.wordbee.com/beebox/releases-2023-02.md)
* [Releases 2023-01](https://help.wordbee.com/beebox/releases-2023-01.md)
---
language: "en"
---
# 2024 Releases
This section shows release announcements for the year 2024
* [Releases 2024-12](https://help.wordbee.com/beebox/releases-2024-12.md)
* [Releases 2024-11](https://help.wordbee.com/beebox/releases-2024-11.md)
* [Releases 2024-10](https://help.wordbee.com/beebox/releases-2024-10.md)
* [Releases 2024-09](https://help.wordbee.com/beebox/releases-2024-09.md)
* [Releases 2024-08](https://help.wordbee.com/beebox/releases-2024-08.md)
* [Releases 2024-07](https://help.wordbee.com/beebox/releases-2024-07.md)
* [Releases 2024-06](https://help.wordbee.com/beebox/releases-2024-06.md)
* [Releases 2024-05](https://help.wordbee.com/beebox/releases-2024-05.md)
* [Releases 2024-04](https://help.wordbee.com/beebox/releases-2024-04.md)
* [Releases 2024-03](https://help.wordbee.com/beebox/releases-2024-03.md)
* [Releases 2024-02](https://help.wordbee.com/beebox/releases-2024-02.md)
* [Releases 2024-01](https://help.wordbee.com/beebox/releases-2024-01.md)
---
language: "en"
---
# 2025 Releases
This section shows release announcements for the year 2025
* [Releases 2025-12](https://help.wordbee.com/beebox/releases-2025-12.md)
* [Releases 2025-11](https://help.wordbee.com/beebox/releases-2025-11.md)
* [Releases 2025-10](https://help.wordbee.com/beebox/releases-2025-10.md)
* [Releases 2025-09](https://help.wordbee.com/beebox/releases-2025-09.md)
* [Releases 2025-08](https://help.wordbee.com/beebox/releases-2025-08.md)
* [Releases 2025-07](https://help.wordbee.com/beebox/releases-2025-07.md)
* [Releases 2025-06](https://help.wordbee.com/beebox/releases-2025-06.md)
* [Releases 2025-05](https://help.wordbee.com/beebox/releases-2025-05.md)
* [Releases 2025-04](https://help.wordbee.com/beebox/releases-2025-04.md)
* [Releases 2025-03](https://help.wordbee.com/beebox/releases-2025-03.md)
* [Releases 2025-02](https://help.wordbee.com/beebox/releases-2025-02.md)
* [Releases 2025-01](https://help.wordbee.com/beebox/releases-2025-01.md)
---
language: "en"
---
# Account & License
Upon first installation you are asked to register your Beebox for an initial 30 days trial. Later you can buy an annual license if you want to continue using Beebox.
## View License Information
The Account \& License page is accessed from the main navigation menu:
The license information display:
* **License status**: Either TRIAL LICENSE or REGULAR LICENSE. The latter is shown if you buy a license.
* **License expiration date**: Indicates the date until which (inclusive) the license is active.
* **Product version** : The version of the installed Beebox. We recommend to regularly upgrade to the [latest release](https://help.wordbee.com/beebox/release-history.md).
* **Features and limitations**: Depending on your license, certain features may be enabled, disabled or limited. The "unlimited" Beebox version gives access to all the features without any limits in terms of project number or data volume.
### Activating or Extending a License
When you buy a regular license (valid for 1 year), extend a trial or change other license details you receive an **Activation Code** from Wordbee. To activate the license:
* Click **Enter activation code**
* Paste your code and confirm
* The license page is updated
The screenshot below shows how a regular license may look:
### Your Account Details
Below the license information you can see your company details and your Beebox administrator login.
To edit details and administrator credentials:
* Click **Edit**
* Make changes and confirm with **Ok**
### Administrator Credentials
The administrator credentials (login, password) are required to connect to the Beebox user interface. During initial registration of the Beebox you were asked to define your login/password.
[Changing credentials](https://help.wordbee.com/beebox/administrator-credentials.md)
### Where is my License Stored?
License details are stored at Wordbee in a License Server. Your Beebox synchronizes with this server once every 24 hours and each time you go to the Account \& License page.
A copy of your license is stored on your server/PC inside the ++c:\\Beebox++ directory. If you accidentally delete the license file or the Beebox directory, you will be asked to register for a trial once again. In that case please contact Wordbee support to move your license to the new installation. When you uninstall or upgrade the Beebox server, the Beebox directory is left untouched. Your license information is preserved.
---
language: "en"
---
# Add CMS Project
In order to translate a CMS you need to create one or multiple Beebox projects. Your CMS will "talk" to this project: It sends translated content to the project and ultimately receives translations back. [Compare project types](https://help.wordbee.com/beebox/project-types.md).
To create a project:
* Login to the Beebox, the list of all your Beebox projects shows up
* Click **New project** in the top right and then **New CMS project**
* A wizard opens. Fill in all fields:
The different fields are:
| Wizard field | Description |
|----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| CMS | Select your CMS. If you have a CMS connector which is not listed then choose "Other CMS". You will then need to do one additional step later. This is described in the CMS connector's user guide. |
| Languages | Choose the source language and the target languages configured in your CMS site. Make sure languages match exactly: * If your CMS uses regional variants such as "German (Germany)" (en-DE) or "English (United States)" (en-US) then select regional variants in the Beebox too. * If your CMS uses base codes such as "German" (de) or "English" (en) then do the same in the Beebox. Note: Some Wordbee CMS connectors (e.g. WordPress) allow transforming web site languages to Beebox languages (e.g. "en" in CMS to "en-US" in Beebox). Refer to the respective CMS connector guide. |
| Translation workflow | Decide how content is translated: * Testing: Use to try how the CMS, the CMS connector and the Beebox work in unison. All content will be pseudo-translated by converting it to uppercase. * Machine translation: All content will be translated by a machine translation system like Google or Microsoft. You will be asked to choose one. * Human translation using Wordbee Translator: All content will be sent to your own translation management system (TMS) or that of your translation service provider. * Human translation using xliff hotfolders: All content will be sent to a TMS by means of xliff files which are exchanged via hotfolders. Some third party TMS support this. * Human translation using manual xliff exchange: Translation is done using xliff. You download xliff files and send to your translators. If you are a Beebox expert you can fine tune or change workflows anytime later [using the automation settings](https://help.wordbee.com/beebox/automation.md). For example to combine machine and human translation. |
| Process content | The Beebox processes content sent by the CMS in regular intervals. Specify this interval. For a test workflow you may want to chose a small interval like 5 minutes to reduce wait times. During production we recommend to choose 30 minutes or more. |
| Automatic approval | *Applicable to human workflows only.* The rule of thumb is: Untick the option to get higher quality translations. When a CMS sends new content, the Beebox will attempt to pretranslate sentences from earlier completed translations. For example, "click here" may have been translated in the past already. Now, it may be that the perfect translation changes depending on the text coming just before and after the sentence (we call this the "context"). The option basically tells whether we want or do not want to send a pretranslated sentence again to a human translator if the context is different than in the past. |
| Project name | Give your project a name. The name can be changed anytime later. |
* Click **Create project and continue** .
* Your project is created. The dashboard page opens.
Depending on your workflow, the dashboard may ask you to do some more configuration.
* If you see the green message below, the project is ready and fully configured.
* If you see the message below, then please continue reading: [Link to Wordbee Translator](https://help.wordbee.com/beebox/settings-translation-vendor.md)
* If you see the message below, then please continue reading: [Add MT system](https://help.wordbee.com/beebox/settings-project.md)
---
language: "en"
---
# Add New Rules
This page describes how to add new rules or supported file formats to a Beebox project. We will focus on selecting rules from presets that are included with the Beebox. The further customization of the presets using XML or Wordbee Translator is discussed here: [Customize Rules](https://help.wordbee.com/beebox/customize-rules.md).
Click the **Edit** link in the project settings page (in top right of the page). The text extraction rule panel exhibits links to add or remove rules:
Click **Add or replace rules** to open this dialog:
The text-box above permits to directly paste XML formatted rule definitions.
However, we skip this for the moment and click **Sample rules**:
You find a selection of commonly used rules.
Click **Select** to chose the rule you want to add to the project. This now display the XML rule definition. We will come back to this format later on.
For this tutorial, we select **Microsoft Word simplified**. Contrary to the default Word rule, this one does not extract document properties, footers and headers for translation.
Click **Save** to confirm your selection. The rule list is now updated:
If we do not want two Microsoft Word rules, we remove the first one by clicking the  icon:
## Further reading
Learn how to customize presets to match your specific requirements:
[Customize Rules](https://help.wordbee.com/beebox/customize-rules.md)
---
language: "en"
---
# Add Pass-Through Project
Pass-through projects switch off all text processing features of Beebox. New or changed source files ("in" directory) directly go into a Wordbee Translator platform: Text extraction, word counting or pretranslation is delegated to Wordbee Translator. Beebox acts as a middle-ware between content sources and Wordbee Translator. [Compare project types](https://help.wordbee.com/beebox/project-types.md).
To create a project:
* Login to the Beebox, the list of all your Beebox projects shows up
* Click **New project** in the top right and then **New Pass-through Project**
* A wizard opens. Fill in all fields:
The different fields are:
| Wizard field ................................................. | Description |
|----------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Copy properties from | Choose to either clone an existing project or to create a new project from scratch. When you select a project from the pick list, most other form options disappear. |
| Languages | Choose one source language and one or more target languages. |
| Process content | The Beebox processes new or changed source content in regular intervals. Specify this interval. For a test workflow you may want to chose a small interval like 5 minutes to reduce wait times. During production we recommend to choose 30 minutes or more. |
| Project name | Give your project a name. The name can be changed anytime later. |
| Project directory | All project related files are stored in a directory inside **c:\\beebox** (or similar). The directory name on disk is either the unique project key (assigned by system) or the project name. The former might look like "c:\\beebox\\c8ae1d0a-c650-4e39-88de-fa580c87de03" and the latter like "c:\\beebox\\myproject". Customizing source and target file locations By default, the directories containing your source and target files are **\\in** and **\\out** inside the project directory. Change this only if source or target files must be stored in specific locations such **FTP** or **Cloud Sharing** directories on the server. Tick the **Customize file locations** option and type directory paths into one or both fields:  |
* Click **Create project and continue** .
* Your project is created. The dashboard page opens.
Since pass-through projects require a connection to Wordbee Translator, you are invited to [establish this link](https://help.wordbee.com/beebox/settings-translation-vendor.md):
---
language: "en"
---
# Add Project
A Beebox project is the starting point to translate content or files:
* It has a name, one source language and one or more target languages.
* It defines a translation workflow that can combine pseudo-/machine-translation and human translation.
* Workflows run automatically, manually or in a mixed mode.
* Source content is copied to the project "IN" directory or sent via the API e.g. from a CMS.
* Translated content is retrieved from the project "OUT" directory or via the API.
To create a project:
* Go to page showing [all projects](https://help.wordbee.com/beebox/all-projects.md)
* Click **New project** in the top right:
Choose the wizard you need:
* [New Regular Project](https://help.wordbee.com/beebox/add-regular-project.md) - The default project in Beebox. Unlocks all Beebox features.
* [New CMS Project](https://help.wordbee.com/beebox/add-cms-project.md) - Use to translate a CMS such as WordPress, SiteCore, Adobe AEM, Joomla
* [New Pass-Through Project](https://help.wordbee.com/beebox/add-pass-through-project.md) - Use to translate files with Wordbee Translator and without pre-processing in Beebox
Compare projects:
* [Compare project types](https://help.wordbee.com/beebox/project-types.md)
---
language: "en"
---
# Add Regular Project
This page describes the wizard for creating new general purpose projects. [Compare project types](https://help.wordbee.com/beebox/project-types.md).
To create a project:
* Login to the Beebox, the list of all your Beebox projects shows up
* Click **New project** in the top right and then **New regular project**
* A wizard opens. Fill in all fields:
The different fields are:
| Wizard field ................................................. | Description |
|----------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Copy properties from | Choose to either clone an existing project or to create a new project from scratch. When you select a project from the pick list, most other form options disappear. |
| Languages | Choose one source language and one or more target languages. |
| Translation workflow | Decide how content is translated: * Manual operations: Use if you do not want any automatic operations but run operations manually from the UI. * Testing: Use for testing a fully automated workflow. All content added to the project will be pseudo-translated by converting it to uppercase. * Machine translation: All content will be translated by a machine translation system like Google or Microsoft. You will be asked to choose one. * Human translation using Wordbee Translator: All content will be sent to your own translation management system (TMS) or that of your translation service provider. * Human translation using xliff hotfolders: All content will be sent to a TMS by means of xliff files which are exchanged via hotfolders. Some third party TMS support this. * Human translation using manual xliff exchange: Translation is done using xliff. You download xliff files and send to your translators. If you are a Beebox expert you can fine tune or change workflows anytime later [with the automation settings](https://help.wordbee.com/beebox/automation.md). For example to combine machine and human translation. |
| Process content | *Option available with certain workflows only.* The Beebox processes content sent by the CMS in regular intervals. Specify this interval. For a test workflow you may want to chose a small interval like 5 minutes to reduce wait times. During production we recommend to choose 30 minutes or more. |
| Automatic approval | *Option available with certain workflows only.* The rule of thumb is: Untick the option to get higher quality translations. When a CMS sends new content, the Beebox will attempt to pretranslate sentences from earlier completed translations. For example, "click here" may have been translated in the past already. Now, it may be that the perfect translation changes depending on the text coming just before and after the sentence (we call this the "context"). The option basically tells whether we want or do not want to send a pretranslated sentence again to a human translator if the context is different than in the past. |
| Project name | Give your project a name. The name can be changed anytime later. |
| Project directory | All project related files are stored in a directory inside **c:\\beebox** (or similar). The directory name on disk is either the unique project key (assigned by system) or the project name. The former might look like "c:\\beebox\\c8ae1d0a-c650-4e39-88de-fa580c87de03" and the latter like "c:\\beebox\\myproject". Customizing source and target file locations By default, the directories containing your source and target files are **\\in** and **\\out** inside the project directory. Change this only if source or target files must be stored in specific locations such **FTP** or **Cloud Sharing** directories on the server. Tick the **Customize file locations** option and type directory paths into one or both fields:  |
* Click **Create project and continue** .
* Your project is created. The dashboard page opens.
Depending on your workflow, the dashboard may ask you to do some more configuration.
* If you see the green message below, the project is ready and fully configured.
* If you see the message below, then please continue reading: [Link to Wordbee Translator](https://help.wordbee.com/beebox/settings-translation-vendor.md)
* If you see the message below, then please continue reading: [Add MT system](https://help.wordbee.com/beebox/settings-project.md)
## Next steps: File formats
By default, a new project comes with only a few file types enabled (such as Word and Xliff)
You will likely want to customize the list of file types:
[File formats](https://help.wordbee.com/beebox/file-formats.md)
---
language: "en"
---
# Admin credentials
These are the credentials you use to login to the Beebox user interface. The credentials procure unrestricted access to all Beebox projects and all data.
You can use your admin credentials for the Beebox API and get unlimited access. Although, you should always use [standard](https://help.wordbee.com/beebox/standard-credentials.md) or [advanced](https://help.wordbee.com/beebox/advanced-credentials.md) credentials unless these are too limited.
The credentials are the same you use when logging into the Beebox UI:
Never disclose your admin credentials to third parties.
## Create API session to access a specific project
If you want to work with content and data of one ++specific++ project, do include the project ID when creating a session.
http://localhost:8089/api/connect?project=f167bce4-66d8-4bc1-8ed6-4c9086ae7a46&login=myadmin&pwd=adminpassword
We specify the admin login, the admin password and the project key. With the obtained session key, all API methods will relate to that project.
### Create API session to access any project and for administration
For unlimited access to all projects and administrative API calls, omit the project ID in the url:
http://localhost:8089/api/connect?project=&login=myadmin&pwd=adminpassword
This returns a project independent session token:
This token can be used for creating new projects, deleting projects, access the Beebox log and any other project independent operation.
In order to manipulate a specific project during your session, you need to append the project ID to the token and use this with your project specific API calls.
{token}*{project id}
For example:
localhost:8089/api/files/file?token=611b27e4-9d09-40ba-b7a8-794aaeff4b07*f167bce4-66d8-4bc1-8ed6-4c9086ae7a46&filename= .....
Next steps: Read about connecting to the Beebox to acces project data in the [API reference](https://help.wordbee.com/beebox/api-connect.md).
---
language: "en"
---
# Admin Methods
This chapter enumerates the API methods sufficient to build CMS (Content Management System) connectors: Connecting to a Beebox, Send source files, Poll translation status and Download translated files. These methods are accessible only with [Admin](https://help.wordbee.com/beebox/admin-credentials.md)level credentials.
---
language: "en"
---
# Administration
In this chapter we discuss configuration of your Beebox and how to track operations and errors:
* [Administration - Summary](https://help.wordbee.com/beebox/administration-summary.md)
* [Administration - Recent Events](https://help.wordbee.com/beebox/administration-recent-events.md)
* [Administration - Email Notifications](https://help.wordbee.com/beebox/administration-email-notifications.md)
* [Administration - IP Whitelist](https://help.wordbee.com/beebox/administration-ip-whitelist.md)
* [Administration - Beebox Extensions](https://help.wordbee.com/beebox/administration-beebox-extensions.md)
* [Manage Logs and Errors](https://help.wordbee.com/beebox/manage-logs-and-errors.md)
* [Manage Windows Service](https://help.wordbee.com/beebox/manage-windows-service.md)
* [Customize Text Segmentation](https://help.wordbee.com/beebox/customize-text-segmentation.md)
* [Public Beebox URL](https://help.wordbee.com/beebox/public-beebox-url.md)
## Track operations and errors
| Task | Purpose |
|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| View Recent Events | View which operations were executed in the Beebox, including any failures. Events are viewed in the Beebox UI. [Administration - Recent Events](https://help.wordbee.com/beebox/administration-recent-events.md) |
| View Logs and Errors | Learn how to track down errors using the Windows Event Log and the Beebox Files Action Log. These give you full error information. Also helpful if you contact Wordbee support. [Manage Logs and Errors](https://help.wordbee.com/beebox/manage-logs-and-errors.md) |
| View Current Connections | Learn how you see who is connected to your Beebox, using the Beebox UI. When you open up the Beebox API to external content management systems, see who interacts with the Beebox. [Administration - Summary](https://help.wordbee.com/beebox/administration-summary.md) |
### Beebox configuration tasks
| Task | Purpose |
|-------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Configure Email notifications | Have the Beebox send you or your clients notifications about important events. For example, notify the creation of translated files. Configure an email server connection and select the events to be notified. [Administration - Email Notifications](https://help.wordbee.com/beebox/administration-email-notifications.md) [Administration - Email Server](https://help.wordbee.com/beebox/administration-email-server.md) |
| Configure Segmentation Rules | Customize SRX rules to split text content into sentences. Beebox comes with predefined rules but you can modify them to your needs. [Customize Text Segmentation](https://help.wordbee.com/beebox/customize-text-segmentation.md) |
| Configure Custom IP Whitelist | Create your own custom list of allowed IP addresses to grant secure API access. [Administration - IP Whitelist](https://help.wordbee.com/beebox/administration-ip-whitelist.md) |
| Add Beebox Extensions | Extend your Beebox with new functionality, developed in Microsoft.Net. [Administration - Beebox Extensions](https://help.wordbee.com/beebox/administration-beebox-extensions.md) |
| Windows Service configuration | Learn about the Beebox Windows service and how to customize startup mode and Windows account. [Manage Windows Service](https://help.wordbee.com/beebox/manage-windows-service.md) |
---
language: "en"
---
# Administration - Beebox Extensions
Beebox extensions or plugins add new custom functionality to your Beebox:
* Pseudo translation algorithms: Commonly used for localization purposes during development and testing. The Beebox includes by default algorithms to "translate" by converting source text to upper case, lower case, by reshuffling characters or by making text longer or shorter.
* Text filters or QA: Accessible from the translation editor to find erroneous translations, missing translations or other content that does not pass quality checks. Plugins are useful if you have very specific QA or filter needs.
* Translated file actions: Can be used to transfer translated files to a different location, to rename files, etc.
Do you need to extend other aspects? Please contact us.
## Where do I obtain extensions?
You can either [develop your own extensions](https://help.wordbee.com/beebox/net-extensions.md) or ask Wordbee to do so. A sample extension can be [downloaded here](https://help.wordbee.com/beebox/downloads.md).
Each extension simply is a zip file that you upload to the Beebox page described below.
### Add, remove and manage extensions
Click **Extensions** to view all currently installed plugins:
### Upload an extension package
To newly upload or upgrade an existing extension, click **Upload package** and select the extension package file.
Packages are ZIP files that contain one or more extensions. In the example above, the package contains three extensions. This is a sample package you can [download here](https://help.wordbee.com/beebox/downloads.md).
If a package is invalid or is not compatible with the Beebox version you have installed then an error message will be displayed. Contact the package developer for help.
### View extension details
Each extension shows its name, version number and author. You can easily remove an extension with the **Delete** link.
Activation: Some extensions are enabled immediately upon download and others may require explicit activation individually per project. In our example above, you can see that the first two extensions are active by default and the third one needs to activated in each project.
Parameters: Some extensions may be configurable. The default parameters shown in the page above can be changed individually per project.
### Activate extensions in projects
Once extensions are uploaded, the [project settings page](https://help.wordbee.com/beebox/settings.md) will show a new block of information at the bottom:
You can switch on or off extensions in the selected project. And, you can change extension parameters.
### Troubleshooting
You will need to contact the developer of the extension to troubleshoot any problems.
If you are a developer, you may want to read the [troubleshooting section for extension developers](https://help.wordbee.com/beebox/troubleshooting-and-tips.md).
---
language: "en"
---
# Administration - Email Notifications
The Beebox can be configured to send email notifications with all or selected events. Examples:
* Send email to the administrator if an operation failed, such as a source file is corrupt and could not be processed.
* Send email to the administrator whenever new files are added to a Beebox project.
* Send email to a client (of a project) as soon as newly translated files are ready for download. This is very useful if the project is linked to a CMS.
The Beebox distinguishes two types of emails:
* Administrator emails are global for the Beebox. These messages contain full event details. Perfect to notify about problems or major events.
* Client emails are configured individually per project (each project may have a different client or stakeholder). Permits customizing message text and emails. Perfect to notify people outside your organization.
This page explains:
## Prerequisite: Configure Email Server
Click Email notification in the Administration page. If you see the message below you will first need to [configure an email server](https://help.wordbee.com/beebox/administration-email-server.md).
[Configuring an email server](https://help.wordbee.com/beebox/administration-email-server.md).
### Configure Administrator Emails
The notifications page shows the different events you want to have notified by email. Clicking Edit lets you choose events and destination email(s):
**Email TO**
By default, the page proposes the email saved in the [Account \& License](https://help.wordbee.com/beebox/account-license.md) page. You can set a different email or even add multiple.
**Email CC**
Optionally, CC messages to more people.
**Send notifications**
Choose the events to be notified. We distinguish actions that succeed (2nd column) and those that fail (3rd column). If you want to hear about failed events only, then untick all success and tick all error messages.
The events types are:
* Source file changes: Triggered when new files to translate are added or sent to the Beebox. Also triggered, if an existing source file is updated with a new version.
* Target file changes: Triggered when the Beebox saves newly translated files to the OUT directory. Basically, this tells you that translated files have just been created and can be picked up from the project directory or using the API.
* Job related changes: Triggered when translation jobs are created, job status changes, job is completed, etc.
* Autorun operations: Triggered whenever automatic operations in a project do some action.
* All operations: All other events, including a change to project properties, deletion of a project, etc.
### Configure Client Emails
Client email notifications are configured individually per project.
[Configuring client notifications](https://help.wordbee.com/beebox/settings-notifications.md)
---
language: "en"
---
# Administration - Email Server
To have the Beebox send [email notifications](https://help.wordbee.com/beebox/administration-email-notifications.md) you first need to configure an email server. This can be your corporate server, Microsoft Exchange, Google Mail, Microsoft Live or others.
Check your firewall: The Beebox will connect to the email server using SMTP. Ensure that the Beebox server firewall permits outgoing TCP/IP connections to the server host and port. Add a firewall rule if access is blocked.
Proceed as follows:
* Go to the **Email server** page:
* Click **Edit** and then tick the **Enable Emails** option. Fill in all parameters for your email server:
* Test your parameters with the **Send a test email** link.
* Finally, click **Ok** in the top right to save your changes.
---
language: "en"
---
# Administration - IP Whitelist
For security, Beebox restricts API access to a predefined list of trusted IP addresses. However, if your Wordbee Translator platform is installed on a private server, its IP address may not be on this default list, preventing communication with Beebox.
The IP Whitelist feature allows you to override the default settings and create your own custom list of allowed IP addresses. This provides you with the flexibility to grant secure API access to trusted platforms, ensuring seamless integration and data exchange.
## **How to Configure a Custom IP Whitelist**
Follow these steps to enable and configure your custom IP whitelist:
1. Navigate to the **Administration** section from the main menu on the left.
Administration drop-down options
2. Either choose **IP Whitelist** from the drop-down options or open the Administration section and click on the **IP Whitelist** tab.
IP Whitelist tab
3. The page will show that the custom whitelist is currently "DISABLED". Click the **Edit** button in the top right corner to change the settings.
4. Tick the checkbox next to **Enable custom IP whitelist** .
Edit view
5. In the **Allowed IP Addresses** text box, enter the IP addresses you want to grant API access to.
Adding IP addresses
If entering multiple IP addresses, you must separate them with a comma (e.g., 50.0.0.2, 192.168.1.10).
6. Click **OK** to save your changes.
Your custom IP whitelist is now active. The page will show the status as "ENABLED" and display the list of IP addresses you have authorized.
IP Whitelist enabled
---
language: "en"
---
# Administration - Recent Events
All operations running in the Beebox are logged with date, executing user, description, notification status and, if applicable, error details.
To view the current connections to the Beebox go to the **Recent events**tab:
The fields shown are:
* **Date**: When the action terminated. The date is shown in your browser local time.
* **Project**: The name of the project concerned.
* **Action**: The title of the operation and a short description. If the operation failed then it shows up in red color.
* **Run by**: Indicates who triggered the operation, any of:
* *Administrator*: The operation was triggered from the user interface (since you need admin credentials to go there)
* *Autorun process*: The operation was triggered automatically. The project uses automation.
* *Connector*: The operation was triggered via the API e.g. from a CMS connector (using non-administrator credentials).
You can configure Beebox to [send out emails](https://help.wordbee.com/beebox/administration-email-notifications.md) to the Beebox administrator. In that case, the Action column shows either one of:
* **Email to manager: Sent**
* **Email to manager: Failed to send**: The Beebox failed to send the email. Make sure that the SMTP server is properly configured.
You can further configure Beebox to[send out customized emails](https://help.wordbee.com/beebox/administration-email-notifications.md) to the Beebox project client. In that case, the Action column shows either one of:
* **Email to client: Sent**
* **Email to client: Failed to send**: The Beebox failed to send the email. Make sure that the SMTP server is properly configured.
You can configure individual Beebox projects to call custom URLs with completed actions. This can be configured in two places: Configure a URL to be called with all project actions: [Project Settings page](https://help.wordbee.com/beebox/settings.md). Configure a URL to notify a CMS connector of completed work: [Connectors \& API page](https://help.wordbee.com/beebox/settings-cms-connector.md).
* **Push notifications: Queued**: The URL was not yet called but will be.
* **Push notifications: Done**: The URL was successfully called.
* **Push notifications: Failed**: The URL could not be called. Likely, the target web server is unavailable or the URL does not exist.
---
language: "en"
---
# Administration - Summary
To view the current connections to the Beebox go to the **Summary** tab:
Below you see the activity information:
**Recent events:**
Shows all recent operations including errors in the Beebox and across all projects. Click here for details.
**Active connections**:
The panel shows all active connections. In the screenshot there is just one (the administrator logged into this UI). You may see more connections if e.g. a CMS is currently "talking" to the Beebox or you are logged in from multiple browsers. You can browse the Web API documentation to see [how external systems do connect](https://help.wordbee.com/beebox/api-connect.md). The different fields are:
* **Active connection**: The name of the connecting system. This name is provided by the connecting system.
* **IP**: The IP address of the connecting system.
* **Access level** : This can be Administrator (connection uses the administrator credentials), Standard (uses [standard credentials](https://help.wordbee.com/beebox/standard-credentials.md)) or Advanced (uses [advanced credentials](https://help.wordbee.com/beebox/advanced-credentials.md)). An external system generally can only connect using Standard or Advanced and can only access information of one specific project.
* **Project**: Either "All projects" or the ID of the specific project to which the active connection has access.
* **Last activity**: The last time the connecting system interacted with the Beebox.
**Reset server / Unlog all users**:
Click to disconnect all active connections. This may be useful if external systems fail to disconnect due to bugs.
---
language: "en"
---
# Administrator Credentials
The administrator credentials (login, password) are required to connect to the Beebox user interface. During initial registration of the Beebox you were asked to define your login/password.
## Editing Credentials
At any time you can change credentials:
* Go to the [Account \& License page](https://help.wordbee.com/beebox/account-license.md)
* Click the **Edit** link under "Account details"
* Tick **Change administrator login and password**
### Make credentials strong
It goes without saying that login and password should be "strong", especially if your Beebox is accessible from the Internet (e.g. when translating external content management systems).
* Combine lower/upper case characters, digits and special characters. Do this for both the login AND the password.
* Regularly change credentials.
* Use a password manager to securely store your credentials.
### Blank credentials during testing
You can leave the login and password field blank in the screen above.
In the login screen you then do not need to fill in anything (just hit the Login button).
Only use when testing and when your Beebox UI is not accessible from the Internet.
---
language: "en"
---
# Adobe AEM
The **Wordbee Beebox Connector for Adobe AEM** makes translating content an efficient and user-friendly process. The connector lets you filter and select content for translation, send content to your translation team or provider, receive finished translations, and have Adobe AEM sites updated with a click.
## Features
**Translation capabilities:**
* Any content -- from pages, titles, subtitles, and descriptions (customizable).
* Any source and target language(s.) -- in any directions.
* Any number of sites within each AEM instance.
* Absolutely ++no manual export++ or import of translation files required. All jobs are completed using web services.
* Automatically tracks which source content has been newly added or changed.
* Automatically tracks which translated content was edited in AEM and may need final approval by translation provider.
* Isolates the HTML markup to protect against unintentional tampering.
* Connects to your preferred translation service providers, in-house team, or TMS.
* Easy tracking of running translation requests.
* Automatically insert completed translations back into the right places.
*Send complete sites, sub-sections, or individual pages using the content selector page.*
**Translation review and editing:**
* Preview and approve translations prior to publishing content.
* Supports the editing of translations directly in AEM.
**Translation cost optimization:**
* It automatically identifies if a sentence or paragraph has been translated in the past. The system automatically reuses past translations and does not send previously translated content to your translation team.
* Automatically identifies repeating sentences and paragraphs from the new translation requests and sends these only once for translation. This may lead to an overall translation volume reduction of 20% or more. Your translation provider receives unique content only (option).
* If your site has already been translated, you can have your existing translations aligned and submitted to your translation team for approval, adding that content to your translation memories.
### Compatibility
* Works with Adobe AEM versions 5.x, 6.x up to 6.5.
* Works with or without initial language copy.
* Automatically updates/creates the target content tree. Locations can be customized per language.
* Supports high volume sites of hundreds of megabytes or more.
* Freely adjust translatable fields using regular AEM component paths.
* Does not interfere with existing AEM workflows.
*Customize translatable fields with Adobe AEM component paths.*
### Videos
[View the videos](https://help.wordbee.com/beebox/adobe-aem-videos.md)
### Implementation
The Beebox Connector is a regular Adobe AEM package (bundle). The package adds the user interface to manage translation jobs.
The Connector then talks to the Beebox middleware using the HTTP protocol. The Beebox server is installed at the AEM/CQ owner's premises, an AEM integrator, or a language service provider. A single Beebox server can connect any number of content management systems with any number of TMS'es or translation teams. Wordbee can provide a list of LSPs who already operate a Beebox server.
Both Beebox Connector for Adobe AEM and Beebox are off-the-shelf products. Installation and configuration support can be provided by Wordbee upon request.
**At a glance**
Adobe AEM 5.x, 6.x
Translates all content
Connects with your LSP or TMS
Tracks content requiring translation
Built-in memories to reduce cost
**Demo, Trial, and Pricing**
[Please contact us](https://www.wordbee.com/contact)
[*Adobe Experience Manager*](http://www.adobe.com/marketing-cloud/enterprise-content-management.html)*is a comprehensive content management solution for building websites, mobile apps, and forms. And it makes it easy to manage your marketing content and assets.*
---
language: "en"
---
# Adobe AEM - Videos
Hands-on with the Beebox Connector for Adobe AEM:
---
language: "en"
---
# Advanced credentials
Similar to the [standard level](https://help.wordbee.com/beebox/standard-credentials.md) but widens the scope of available API methods. For example, allows creation and manipulation of Beebox jobs. You would only opt for this access level if you want to control internal workflows in the Beebox.
* Integration projects requiring advanced Beebox data control.
* Access limited to one specific Beebox project. Credentials created per project.
* Access to wide range of API methods, including:
* Get source segments and translations. Update translations through API.
* Create Beebox jobs, manage jobs and send to TMS via API.
* Can be disclosed to trusted third parties (API may directly trigger the transfer of data to a TMS).
## Create credentials
Credentials are created individually per project. When connecting to the API, the caller can only interact with data from the project.
(1) Login to the Beebox UI.
(2) Select a project and click the "Connectors \& API" tab:
(3) Click "Edit" and toggle the switch to "ON": Fill in a login and password.
Make sure to tick the "Advanced connector" option.
(4) Click "Ok" to save your credentials
Once saved you will see the unique identifier of the project. You need this when connecting.
### Connect to the API
You are now ready to connect to the API, example:
http://localhost:8089/api/connect?project=f167bce4-66d8-4bc1-8ed6-4c9086ae7a46&login=mylogin&pwd=superpassword
You can test this in a web browser. The result is the session token:
Next steps: Read about connecting to the Beebox in the [API reference](https://help.wordbee.com/beebox/api-connect.md).
---
language: "en"
---
# Advanced methods
The API lets you control virtually any aspect of the Beebox.
Unfortunately, we cannot document them all, there are simply too many. However, you can easily find the methods that do what you need.
First off, you should know that the web user interface of Beebox uses the API itself. This has a consequence: Whatever the UI can do you can do as well! Using any web browser you can identify the API method URL, verb and results.
## Example: Find API method to show source files statistics
We will show how you use a web browser to find API methods. We are using Google Chrome but you can use any other browser.
* Open a web browser and login to the Beebox user interface
* Select a project and navigate to the **Source files** page:
* Press the **F12** key. In Chrome this opens the developer pane:
* Click the **Network** tab and **XHR** a bit further down. Make the panel bigger if you cannot see all the information.
* Press the **F5** key to reload the page. You can now see the API calls of the page:
* As the name tells, the first call retrieves the statistics. Click it to see more details:
You can see the full URL of the API call with all the parameters. The HTTP verb used by the call is printed just below. In our example it is a GET.
* Now review the results of the call by clicking **Response**:
If you need help please contact Wordbee support.
### Future support for undocumented API methods
We cannot guarantee that undocumented methods will not change or be deprecated in the future.
Contact Wordbee to have a specific method documented. This then guarantees future support.
---
language: "en"
---
# Alignment Dictionaries
Historically, alignment permits to build translation memories from existing translations. With the Beebox alignment can also be used to capture edits in translated files. Learn more here: [How do I align content?](https://help.wordbee.com/beebox/how-do-i-align-content.md) Alignment is not error free and you can substantially enhance results by uploading relevant dictionaries. These are Excel formatted lists of words or terms together with their translation. If a lot of these terms appear inside your source texts, the alignment algorithm can use your dictionary to optimize results.
## 1. Upload your words and terms
Start with creating a new translation memory and upload your terms in Excel format. [Click here](https://help.wordbee.com/beebox/translation-memories.md) to see how this is done.
Next, tick the **Alignment dictionary**option:
### 2. Build your dictionary
Go to the **Alignment dictionaries** tab and you will see your previously uploaded dictionary.
Click Build dictionaries to prepare your dictionary for use by the alignment tool. You need to push this button whenever you change your dictionary.
---
language: "en"
---
# Alignment - FAQ
Frequently asked questions:
## When to use alignment? Always?
Not always! Use alignment only when necessary and when you made sure that the quality is to your expectations.
If you create a Beebox project for the purpose of aligning a lot of files, you would of course enable alignment by default (no need to create instructions files). Please note that some languages may encounter difficulties with alignment due to different lengths between phrases in the source language and the target language.
If you integrate the Beebox with a CMS you should use instructions files so that the CMS tells the Beebox exactly which translated content needs to be aligned: The content that was actually edited or annotated by the user.
### When and how does the Beebox align?
When the Beebox receives a source file it proceeds as follows:
* The source file is segmented and pre-translated from the Beebox memories.
When you further include translated files and the instructions file, it adds these steps:
* The translated files are aligned. For the alignment algorithm to work more precisely, a "training" file is created on the fly. The file includes all the pre-translations found in step 1 plus any alignment dictionaries that were optionally configured in the Beebox project.
* The pre-translations of step 2 are now replaced by the aligned translations. If alignment is not possible for some pieces of the content, the pre-translations in step 1 are kept.
The next steps are the same whether you align or not:
* The Beebox selects all unapproved translations (segments). These are sent to MT and/or a TMS. Approved translations are considered "final" and are not sent to MT or a TMS.
### When does the Beebox approve aligned content?
How does the Beebox decide if translations are approved or not? There are two rules:
* By default, aligned translations are flagged as "unapproved". This is a design decision since alignment may not be perfect and require human approval in the TMS.
* If an aligned translation (step 4) is identical to the pre-translation (step 1) and the pre-translation itself is approved, then the aligned translation is considered "approved" too.
If these rules sound too technical, the following two examples may add some clarity:
* If you send the file and there is no memory yet in the Beebox, the system will yield translated segments coming exclusively from the translated file (no pre-translation in step 1).
All segments are "unapproved" and a human will have to approve/fix the results.
* You already had translated source file in the past. You now receive a new version of the source file + translations. At this point, both the source file and the translated file may have been edited, maybe or maybe not.
The Beebox will align the files and identify all changes, both in the source and the translations (with respect to the previously done translations). All the changes are flagged as "unapproved". All the content that did not change are flagged as "approved".
The final result: Only the changed segments will be sent to the TMS.
### What technology do you use?
The Beebox integrates the "*hunalign* " open source library for alignment purposes. The library home page is:
We improve on alignment quality with mechanisms that intelligently incorporate translation memory technology and pretranslations available per each file to align.
---
language: "en"
---
# Alignment - Improve Quality
You can substantially improve alignment results by uploading relevant words and terms together with their translations.
Navigate to the **Resources** page of your project and upload a memory or dictionary. Then tick the **Alignment dictionary** option.
Read more: [Alignment Dictionaries](https://help.wordbee.com/beebox/alignment-dictionaries.md)
---
language: "en"
---
# Alignment - Step by Step
This chapter describes how to send original files/content plus any translated files/content to the Beebox and get translations aligned. We assume that you are already familiar with the Beebox and will skip more general explanations.
## Align all files added to a project
This is the easiest way of aligning your files. Basically you copy all source files plus all translated files to the project. Then the Beebox will align all your content.
The aligned content can then be exported to XLIFF or sent to a TMS for further editing or approval.
The steps are:
* Create a project and go to **Settings**
* Tick the **Align by default** options
* Copy your source files to the project "in" directory
* Copy your translated files to the project "out" directory, inside the language folders:
* For example the French translation to **\\out\\fr\\marketing\\myfile.docx**
* You can work in multiple target languages at the same time
Then instruct the Beebox to process your files:
* Go to **Source files**
* Click**Process new files**
Review the content.
### Selectively align files using "instructions files"
Let us suppose that we have an English source file named "marketing\\myfile.docx". We further have existing French and Spanish translations of this file.
This is how you copy the files to the Beebox project directories:
1. Copy the French translation to ...\\**out\\fr**\\marketing\\myfile.docx
2. Copy the Spanish translation to ...\\**out\\es**\\marketing\\myfile.docx
3. Copy an instructions file to ...\\**in** \\marketing\\myfile.docx**.beebox**
This file contains Json and is UTF-8 encoded:
{ "align": { "locales": \["fr", "es"\] } }
4. Copy the original file to ...\\**in**\\marketing\\myfile.docx
When the Beebox then processes the source file it will see the instructions file and align the translated files. The Beebox now contains the source segments and the translations in French and Spanish. Note that when sending a source file without translations, you would just do step 4.
Comments:
* Always copy the source file at the end. This is important in automated setups where the Beebox polls the "in" directory for new/changed source files. We want to have the Beebox poll the source file only after we have properly copied the translations and the instructions.
* Note that the translations are saved to the "out" directory and inside the language specific sub-directory. Make sure your Beebox project is configured for these exact languages.
* Note that the translated files are given the exact same relative path (name) as the source file. This is essential or otherwise the Beebox will not find your files.
* The instructions tell the Beebox that it shall extract and use the translations from the French and Spanish files. You must indicate the "locales" node with the list of languages (at least one).
There is a nice [video tutorial to get started](https://youtu.be/scQQ8Wxhk4g?list=PLB66C5wGhslyYA0tL1-7hBJToXFCGzvjG)
### Align files using the API
Instead of copying files to the "in" and "out" directories of a Beebox project, you can of course do this with the API.
The steps are:
1. Send the French translation in the body of API method:
(PUT) /api/files/file?token=\&locale=**fr**\&folder=\&filename=marketing\\myfile.docx
2. Send the Spanish translation in the body of API method:
(PUT) /api/files/file?token=\&locale=**es**\&folder=\&filename=marketing\\myfile.docx
3. Send the instructions file in the body of API method:
(PUT) /api/files/file?token=\&locale=**en** \&folder=\&filename=marketing\\myfile.docx.**beebox**
This file contains Json and is UTF-8 encoded:
{ "align": { "locales": \["fr", "es"\] } }
4. Send the English original content in the body of API method:
(PUT) /api/files/file?token=\&locale=**en**\&folder=\&filename=marketing\\myfile.docx
[API documentation](https://help.wordbee.com/beebox/web-api.md).
### Example of a post-editing workflow
This is a frequent use-case for which other tools do not propose a solution and which the Beebox handles in a breeze.
The scenario: You send a source file "myfile.docx" to the Beebox for translation into French.The Beebox translates and saves the result to "...\\out\\fr\\myfile.docx". The customer opens the translated file and makes changes to it or types inline comments:
How do you get the changes or comments back into the Beebox and your TMS? Changes are needed to update Beebox and TMS memories; Comments need to go to the translation team to take action...
In the Beebox simply update the translated file, the location being unchanged: ...\\out\\fr\\myfile.docx.
Add the instructions file with the "align" node and update the date of the source file. The latter is required or otherwise the Beebox will not process the file again: It looks at the source file date and only picks source files only if the creation or modification date has changed.
Once this is done, the Beebox will read source and translation, align them and incorporate all the changes done.
The complete scenario is:
* Initial translation:
* Send source file to Beebox and wait until translated file is created.
* Deliver file to customer.
* Post editing:
* Customer edits the translated file and sends it back to you
* Second translation:
* You save the file to the "out" directory and update the source file's date
* The Beebox will incorporate all the changes both in the source file (if any) and the translated file (edits, comments).
* The Beebox will create the translated file with any further updates done by the translation team.
* Deliver file to customer.
* Post editing, again:
* If the customer does further editing, start over again...
---
language: "en"
---
# Alignment - When to Use
Alignment in the Beebox serves multiple purposes:
|---------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|
| **Use case** | **Description** | **Comments** |
| **Import legacy translations from source and translated files (Word, Excel, XML...)** | Some or all of your content is already translated. You may or you may not have translation memories. When saving a source file to the Beebox, simply include your existing translated files. The Beebox will automatically align the files and extract not just the source segments but also the translations. If you have translation memories, upload those to the Beebox beforehand. Memories are leveraged to improve alignment quality. Upload dictionaries to further improve alignment quality. | No preliminary alignment with 3^rd^ party tools required. No manual work. Existing memories or dictionaries can help improve quality of results. |
| **Permit editing of translated files and have Beebox update memories directly** | When using the Beebox for translation, translated content must not be further edited outside the Beebox. The reason is that those changes do not usually go back to the Beebox and its memories. Using alignment, you can safely permit users to edit translated content outside the Beebox. After any editing is done, simply send the original file + the edited translated file once again to the Beebox. This will align the content, detect changes in the translation and immediately update Beebox memories. The changes are then queued for human approval. | Perfectly synchronizes translations between CMS, Beebox and TMS. |
| **With CMS systems: Let users review, edit and annotate translated pages** | This point is similar to the one above. CMS users may want to proofread newly translated content from within the CMS. They may then make changes (see previous point) or leave comments for the translation team. Such a comment would be typed into the translated page/file such as: *"(This text is too long, doesn't fit on screen -- please shorten!)"*. Once the user has added comments, simply extract the original and the translated content or file again to the Beebox. The Beebox now aligns content, detect changes (aka comments) in the translation. The changes and comments are then sent to the human translation team (TMS link or via Xliff). | Send comments by CMS user to the translation team. |
---
language: "en"
---
# All Projects
You access the list of all your projects by either clicking the **Projects** button in the left navigation bar or, if you have a project open, from the **Projects** link in the top right of the page:
You have the ability to create a new project and to select a project for viewing, editing, or removal.
* Click **New project** to [add a new project](https://help.wordbee.com/beebox/add-project.md)
* Click **Select** to navigate to a project
* Click the  icon to access specific project pages and to delete a project:
The project list shows the most important project properties:
* The name of a project
* The optional description, if any
* Source language (a project always has exactly one)
* Target language(s)
* Type of CMS if this project is for translating a content management system
* Total number of source items or files
---
language: "en"
---
# API - Check Beebox availability
This API method simply checks if there is a Beebox listening at a given server and port.
CMS connectors typically use this method to validate if the configured server URL is valid. If not, an error message is displayed to the user.
Possible reasons of unavailability:
* Check Beebox server or company firewall: Must allow incoming HTTP connections on the port. Port number is 8089 by default but can be changed in Microsoft IIS.
* Make sure the Beebox Windows service is started
* Maybe wrong Beebox url, port number or http/https protocol selected
## URL
(GET) /whois
### PARAMETERS
None. You do not need a session token.
### RESULTS
The method returns status code 200 and this JSON:
{"name":"Beebox API"}
If there is no Beebox, either because it is not installed or no network connection (firewall) can be established you will get an HTTP error status.
### EXAMPLES
Server exists at that name?
http://targetserver.com:8089/whois
Server at IP with SSL and port 80?
https://targetserver.com/whois
---
language: "en"
---
# API - Connect
You start by connecting to a Beebox project. Upon connection, you obtain a session token. This token is included with all subsequent calls.
For security reasons we recommend the new authentication method using POST rather than GET:
## URL
(GET) https://{server}/api/connect?project=\&login=\&pwd=\&waitsecs=\&connector=\&version=
### PARAMETERS
The URL parameters are:
|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| project | The identifier of the project to connect to. You can find this id in the project settings page: |
| login | You can create credentials individually per each project. Go to the project "Settings", then select "Connectors \& API" and create login/password. These credentials can access data in the specific project and basic API methods only. Typically, these credentials would are perfect for CMS (Content Management System) connectors. Alternatively, you can use the administrator credentials. In that case, you need to follow special rules. |
| pwd | |
| waitsecs | Optional number. Default is 10. Indicates the timeout in seconds for this call. Purpose: Whenever the Beebox executes automated operations, it blocks login attempts. This parameter indicates how long the login method waits before it returns an error. |
| connector | Free text that identifies your connector. For example "Drupal by xy". Keep it a short product name. |
| version | Free text containing the version number of your connector. For example "1.1.0". |
### RESULTS
The API returns a session token which you include with all subsequent API calls.
It is important to verify the [HTTP status code](https://help.wordbee.com/beebox/error-handling.md). If authentication succeeds, the method returns HTTP code 200 (success). All other HTTP codes point to an error.
If the server is busy due to a running server operation, the method will wait for the number of seconds specified in the "waitsecs" parameter. If the server is still busy after this period, the method fails with an [error id "BUSY"](https://help.wordbee.com/beebox/error-handling.md). In that case please wait a few seconds and retry.
HTTP status codes
With every API call, you need to check the HTTP error code. 200 and 204 equal success. All other codes point to an error.
### DISCONNECTING
Always invalidate your token when you no longer need it. Failing to do so may put on hold automatic operations.
See [API - Disconnect](https://help.wordbee.com/beebox/api-disconnect.md).
---
language: "en"
---
# API - Connect (using POST)
You start by connecting to a Beebox project. Upon connection, you obtain a session token. This token is included with all subsequent calls.
## URL
^(POST) https://{server}/api/connect^
### PARAMETERS
The request BODY must be a JSON object with these parameters:
|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|
| project | The identifier of the project to connect to. You can find this id in the project settings page: | Mandatory |
| login | You can create credentials individually per each project. Go to the project "Settings", then select "Connectors \& API" and create login/password. These credentials can access data in the specific project and basic API methods only. Typically, these credentials would are perfect for CMS (Content Management System) connectors. Alternatively, you can use the administrator credentials. In that case, you need to follow special rules. | Mandatory, string |
| pwd | The password. | Mandatory, string |
| waitsecs | Optional number. Default is 10. Indicates the timeout in seconds for this call. Purpose: Whenever the Beebox executes automated operations, it blocks login attempts. This parameter indicates how long the login method waits before it returns an error. | Optional, Integer |
| connector | Optional. Free text that identifies your connector. For example "Drupal by xy". Keep it a short product name. This information will be logged and is visible by the Beebox admin. | Optional, string |
| version | Optional. Free text containing the version number of your connector. For example "1.1.0". This information will be logged and is visible by the Beebox admin. | Optional, string |
### RESULTS
The API returns a session token which you include with all subsequent API calls.
It is important to verify the [HTTP status code](https://help.wordbee.com/beebox/error-handling.md). If authentication succeeds, the method returns HTTP code 200 (success). All other HTTP codes point to an error.
If the server is busy due to a running server operation, the method will wait for the number of seconds specified in the "waitsecs" parameter. If the server is still busy after this period, the method fails with an [error id "BUSY"](https://help.wordbee.com/beebox/error-handling.md). In that case please wait a few seconds and retry.
### HTTP status codes
With every API call, you need to check the HTTP error code. 200 and 204 equal success. All other codes point to an error.
### DISCONNECTING
Always invalidate your token when you no longer need it. Failing to do so may put on hold automatic operations.
See [API - Disconnect](https://help.wordbee.com/beebox/api-disconnect.md).
---
language: "en"
---
# API - Create new project
The purpose of this method is to create a new project
## URL
(POST) /api/projects/new
### PARAMETERS
Parameters are:
|------|---|
| body | |
---
language: "en"
---
# API - Delete project
The purpose of this method is to delete the project. Deleted project cant be restored.
## URL
(GET) /api/projects/{projectkey}?token=
### PARAMETERS
Parameters are:
|-------|---------------------------------------------|
| token | The session token obtained when connecting. |
### RESULTS
The method returns JSON and HTTP status 204. Other [HTTP status values](http://documents.wordbee.com/display/bb/Error+Handling) indicate an error.
---
language: "en"
---
# API - Delete project log
Each project has own log, those logs can be clean by the following method.
## URL
(DELETE) /api/projects/{projectkey}/log/fileactions?token=
### PARAMETERS
Parameters are:
|-------|---------------------------------------------|
| token | The session token obtained when connecting. |
### RESULTS
The method returns JSON and HTTP status 204. Other [HTTP status values](http://documents.wordbee.com/display/bb/Error+Handling) indicate an error.
---
language: "en"
---
# API - Delete translated content
This method lets you delete source files, instructions files and translated files from the IN, OUT and sandbox directories.
## URL
(DELETE) /api/files/file?token=\&locale=\&folder=\&filename=
Please note that this is an HTTP DELETE action.
### PARAMETERS
Parameters are:
|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| token | The session token obtained when connecting. |
| locale | Either the source language code, a target language code or "sandbox" to delete sandbox files (used to [obtain cost quotations](https://help.wordbee.com/beebox/api-get-cost-quotation.md)). Language codes are ISO 2 letter codes such as "en", "fr", "en-GB", "en-US", etc. Can be nullable |
| filename | The relative path of the file including sub-directories. * This can be a simple file name like "*myfile.xml*". * Or, it can include directories such as "*folder1\\folder2\\myfile.xml*". Note the use of backslash separators as it is common on Windows systems. Can be nullable |
| folder | Folder name (also it can be specified in filename) Can be nullable |
### RESULTS
The method returns no result. An HTTP status of 204 indicates success.
If the ++file does not exist++, the method returns HTTP 400.
See [HTTP status values](https://help.wordbee.com/beebox/error-handling.md) for error handling.
---
language: "en"
---
# API - Delete translated content directory
This method lets you delete all files in a sub-directory of the IN, OUT or Sandbox directories. This is useful if you group files inside sub-directories. For example, a source file "myfolder1\\myfile.docx" is located inside folder "myfolder1".
## URL
(DELETE) /api/files/directory?token=\&locale=\&folder=\&directoryname=
Please note that this is an HTTP DELETE action.
### PARAMETERS
Parameters are:
|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| token | The session token obtained when connecting. |
| locale | Either the source language code, a target language code or "sandbox" to delete sandbox files (used to [obtain cost quotations](https://help.wordbee.com/beebox/api-get-cost-quotation.md)). Language codes are ISO 2 letter codes such as "en", "fr", "en-GB", "en-US", etc. |
| directoryname | The relative path of the sub-directory. * This can be a folder like "*myfolder1*". * Or, it can include further directories such as "my*folder1\\folder2*". Do not use absolute paths - these are not allowed. |
### RESULTS
The method returns no result. An HTTP status of 204 indicates success.
If the ++directory does not exist++, the method returns HTTP 400.
See [HTTP status values](https://help.wordbee.com/beebox/error-handling.md) for error handling.
---
language: "en"
---
# API - Disconnect
A typical API session starts with a connect and ends with a disconnect. You should always explicitly disconnect from the API. Failing to do so, makes the Beebox believe that you are still logged on (at least until the session expires after 15 minutes of inactivity). As long as a session is active, the Beebox will not execute any automatic operations.
## URL
(GET) https://{server}/api/disconnect?token=
### PARAMETERS
|-------|-------------------------------------------------------------------------------|
| token | The session token obtained upon [initial connection](https://help.wordbee.com/beebox/api-connect.md). |
### RESULTS
The method returns no result even when the token is not or no longer valid.
---
language: "en"
---
# API - Enumerate languages
Beebox uses ISO 2-letter language codes and English titles: [About language codes in the Beebox](https://help.wordbee.com/beebox/language-codes.md).
This API method is helpful during development. When interacting with a Beebox project, be aware that you can only use the languages defined in that project.
To get the list of a project's languages, you would use [API - Get project information](https://help.wordbee.com/beebox/api-get-project-information.md) instead.
## URL
(GET) /api/utility/languages?token=
### PARAMETERS
|-------|---------------------------------------------|
| token | The session token obtained when connecting. |
### RESULTS
The method returns a JSON array of languages:
[
{"v":"af","t":"Afrikaans"},
{"v":"af-NA","t":"Afrikaans (Namibia)"},
{"v":"af-ZA","t":"Afrikaans (South Africa)"},
{"v":"ak","t":"Akan"},
{"v":"ak-Fant","t":"Akan (Fante)"},
{"v":"ak-Fant-GH","t":"Akan (Fante, Ghana)"},
{"v":"sq","t":"Albanian"},
...
]
An HTTP status of 200 indicates success. Other [HTTP status values](https://help.wordbee.com/beebox/error-handling.md) indicate an error.
---
language: "en"
---
# API - Export job
The method used to export the job to xliff or zip file. If a single language job or filter.targetLocale is specified, the method returns a flat xliff file.
With multilanguage jobs, this returns a zip file with xliff's inside per language.
## URL
(GET) /api/texts/package/xliff?token={token}&packageid={packageid}&filter={filter}&filename={filename}
### PARAMETERS
Parameters are:
|-----------|------------------------------------------------------------------------------------------------------------------------------------------------|
| token | The session token obtained when connecting. |
| packageid | Package id |
| filter | Optional content filter |
| filename | Optional filename. Note that the extension will be overwritten to either .xlf or .zip depending on whether we have a single target or multiple |
### RESULTS
The method returns file and HTTP status 200. Other [HTTP status values](http://documents.wordbee.com/display/bb/Error+Handling) indicate an error.
---
language: "en"
---
# API - Export translation memory
Method exports memory into xliff file
## URL
(GET) /api/texts/tm/xliff?token={token}&filename={filename}&filter={filter}&folder={folder}&file={file}&projectonly={projectonly}&skip={skip}&count={count}
### PARAMETERS
Parameters are:
|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| token | The session token obtained when connecting. |
| `filename` | Optional. File name was given to the download. If not set, uses "export.xlf" Can be null |
| `filter` | Use "resourceId" to specify a specific memory. Otherwise, it's project memory. Specify the target locale. Otherwise, the method selects the first target locale in the memory Can be null |
| `folder` | Optional. If set, only get contents with this filename |
| `file` | Optional. If set, only get contents with this folder name Can be null |
| `projectonly` | If you specify project memory, indicate whether only to export contents for which files exist in the folder or any contents. Can be null |
| `skip` | Integer Can be null |
| `count` | If 0 then unlimited size Can be null |
### RESULTS
The method returns no result. An HTTP status of 200 indicates success.
See [HTTP status values](https://help.wordbee.com/beebox/error-handling.md) for error handling.
---
language: "en"
---
# API - Full event details
The callback URL receives event information including errors in its URL parameters. For some events you may require more details. You can use the API to obtain full details per each event.
For example, use the API to obtain the full list of translated files created. This action is notified by event type "CreatedTranslatedFiles".
## **URL**
To get a specific event in the project you are logged in:
(GET)/api/actions/action?token=\&id=
To get a specific event in any project. You need to connect to the Beebox using the admin credentials:
(GET)/api/server/actions/action?token=\&id=
## **PARAMETERS**
|----|------------------------------------------------------------------------------------------------------------------------------------|
| id | The event id is included with push URLs and when enumerating all events. If the event does not exist an error message is returned. |
## **RESULTS**
The method returns full details of the event including the list of processed files. Example:
{
"id": 1002
"details": {
"files":[
{"date":"2015-01-20T08:48:21.2142634+00:00","type":"S","locale":"en",
"spath":"c:\\beebox\\7372c828-320d-4ddf-9522-593414bd8b73\\in\\product1.json",
"tpath":null,"err":null,"errex":null
},
{"date":"2015-01-20T08:48:21.2563038+00:00","type":"T","locale":"es",
"spath":"c:\\beebox\\7372c828-320d-4ddf-9522-593414bd8b73\\in\\product2.json",
"tpath":"c:\\beebox\\7372c828-320d-4ddf-9522-593414bd8b73\\out\\es\\pro
duct2","err":null,"errex":null
}
]}
...
}
The resulting json is:
| Property | Description |
|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| id | The unique id of the event. |
| date | Date of event. |
| projectkey | Beebox project to which this event refers to. |
| projectname | Beebox project name. |
| action | User friendly description of the action. |
| actioncode | A code identifying the type of event. This corresponds to the "bbid" parameter when using callbacks. |
| info | May contain additional information on the action. User friendly text. |
| sender | The role of the initiator. |
| success | Boolean. True if the operation succeeded. False if it failed. |
| error | If the operation failed, this field contains a short error description. |
| details | Additional and event specific json details. For example the events of type "CreatedTranslatedFiles" and "SourceFileParsed" include the complete list of source or target files processed. The property is always null if the API URL parameter "fulldetails" is false. |
| pushurl | If the Beebox project is configured to notify an external system of an event (push notification), then this is the URL that was called (or will be called). |
| pushresult | Indicates the status of the push notification. Possible values are: • Waiting: The push was not yet done but will be within very shortly. • Skip: This event does not need to be pushed. • Done: Push done. • Failed: The URL could not be opened. If you see this kind of error please double check if the URL is valid and the Beebox server has the right to access the URL. |
| emailadminresult | If administrator email notifications are enabled in the Beebox project of this event, then this property indicates whether the email is already sent out or not. Emails can be configured in the "Emailnotifications" tab of the project settings page. The values are "Waiting" (email not yetsent), "Skip" (no email to send or emails disabled), "Done" (email sent) and "Failed" (email could not be sent). Administrator emails are sent for all event types. |
The "details" property has this structure:
| Property | Description |
|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------|
| date | Date when the file was processed. UTC and ISO formatted. |
| type | "S" if the operation refers to the analysis of a source file (text extraction). "T" if the operation refers to the creation of the translated file. |
| locale | If type is "S" then this is the source language. Otherwise it is a target language. |
| spath | The full path of the source file |
| tpath | The full path of the translated file. Applies only if "type" is "T". |
| err | Optional text. Null if the operation succeeded. Otherwise a short error message. |
| errex | Optional text. If the operation failed, this property contains verbose and technical error details. |
## **REMARKS**
When your URL is called it includes parameter "bbid" which is the related event ID. You can now connect to the API and retrieve the full event details. Please note that the login may occasionally time out due to running Beebox server operations. In fact automatic operations start immediately after the Beebox has opened the callback URLs. If you receive a timeout, please wait a few seconds and then try again.
## **EXAMPLE**
See this page for an example:
[Event Details - Created Translated Files](https://help.wordbee.com/beebox/event-details-created-translated-files.md)
---
language: "en"
---
# API - Get Account details
The purpose of this method is to retrieve all account information.
## URL
(GET) /api/account?token=
### PARAMETERS
Parameters are:
|-------|---------------------------------------------|
| token | The session token obtained when connecting. |
### RESULTS
The method returns JSON and HTTP status 200. Other [HTTP status values](http://documents.wordbee.com/display/bb/Error+Handling) indicate an error.
### EXAMPLE
A typical result may look like:
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| { "account": "Test", "beeboxAccountKey": "134ad8a2-2127-4b51-aee", "publicurl": null, "login": null, "details": { "companyName": "test", "contactName": "test", "contactEmail": "test@wordbee.com", "phone": null }, "productVersion": "1.05", "license": "TRIAL LICENSE: Product is licensed until 18/10/2029.", "licenseRequired": false, "canuse": true, "setupRequired": false, "updateAvailable": null, "hasActivationCode": false, "licenseDetails": { "accountName": "Test", "accountKey": "134ad8a2-21", "unregistered": false, "canuse": true, "akinvalid": false, "acinvalid": false, "istrial": true, "info": "TRIAL LICENSE: Product is licensed until 18/10/2029.", "licensee": { "companyName": "Test", "contactName": "test", "contactEmail": "test@wordbee.com", "phone": null }, "trialEnd": "2020-10-18T04:47:22.253", "trialActivationRequired": false, "licenseEnd": null, "licenseActivationRequired": false, "licenseComments": "", "lockips": false, "callerips": [ "212.66.68.00" ], "features": { "pname": "Beebox Server", "maxProjects": 0, "maxSegments": 0, "maxWords": 0, "maxTSegments": 0, "maxTWords": 200000, "projectTypes": [ 0, 2 ], "items": [ { "title": "Product name:", "desc": "Beebox Server" }, { "title": "Maximum translated words:", "desc": "Up to 200,000" }, { "title": "CMS and Files translation:", "desc": "Enabled" } ] }, "message": null } } |
[Next Page](https://help.wordbee.com/llms-full.txt/1)