CMS Integration

This page discusses the integration of CMS systems into Wordbee Translator with just a few API methods.

Introduction

The API facilitates efficient and robust integrations with Content Management Systems (CMS). Let’s delve into its key features:

Project Creation: Begin by setting up a Standard or Codyt project. This project acts as a container for all the content that requires translation. If your CMS supports webhooks, configure your endpoints to receive notifications when content is translated.
Content Transfer: Leverage the API to seamlessly transfer content from your CMS to the project. Whether it’s text, images, or any other format, the project accommodates it all. The project persists indefinitely, serving as a reliable hub for your CMS’s translation needs.
Workflow Execution: Within the project, translation teams can refine and execute their workflows. Treat it like any other Wordbee Translator project. Collaborate, iterate, and ensure accurate translations.
Webhooks and Notifications: Real-time notifications are crucial. Set up webhooks to receive alerts upon content completion. Alternatively, actively monitor the project for finished workflows.
Retrieve Translations: Effortlessly retrieve the translated content from within the project. It’s readily available for your use.

For deeper insights and guidance, we recommend thoroughly reviewing the documentation.

Learn how to setup a new integration project and how to obtain an API key.

The main API methods you need are:

Action	API Methods
Push content from CMS into project	Use: projects/{pid}/workflows/new The content file is stored in the project and assigned a unique Document ID. Subsequent API methods will ask you for this number. Document ID and Target Language refers to a workflow. A document has as many workflows as it has target languages. Translation workflows are automatically started (if configured in project) and the translation team can start its work. You can optional include attachments for screenshots and reference material.
Check for completed workflows	Either listen to web hooks or poll for recently completed workflows using projects/{pid}/workflows/list/completed
Check status of completed workflow	This step is optional. The previous step already tells you which workflows are completed and you can proceed with the download of the translated content. See Get Workflow Status The methods are useful if you want to check on the deliverable existence, creation date and file size.
Download deliverable	Pull translated content for a given workflow (Document ID + Target Language). See Download Deliverables
Confirm delivery	Tell Wordbee that you successfully pulled the file by changing the workflow status from “Work finished” to “Work delivered”. This information is visible to the project manager. See Confirm Delivery

We recommend that you read through all the workflow related APIs. For example:

Learn how to attach reference files or screenshots to your content: Manage attachments
Pull word counts: projects/{pid}/workflows/{did}/wordcounts/{trg}