System API v2

Welcome to the documentation of the API version 2. It is a web-based API to retrieve and update information in Wordbee Translator.

A key difference compared to version 1 of the API is that API credentials can be created individually per user. Credentials inherit the access rights (or profile) of the users. You can create dedicated API users to allow different people or systems to interact with the API and within a defined framework of rights.

The API sample root URL can be:

CODE

The API 2 endpoint is your Wordbee Translator URL + /api

Chapters:

Overview

Endpoints

Error handling and code

Authentication — API methods currently use a token based mechanism.

Creating API Keys

Projects — Provides methods to work with projects, their documents, word counts and other.

Jobs — Provides methods to enumerate and manage jobs.

Workflows

Resources — This namespace provides API methods to retrieve and manipulate data related to segments, documents, document sets, source/target files and attachments and other related data.

Persons — API methods to retrieve or update information related to persons (users).

Companies — API methods to retrieve or update information related to companies: my company, supplier companies, client companies.

Invoices — This section describes invoice related methods: Find invoices. View details, update details, delete invoices.

Services

Orders

Business Reports

Business Analytics — Provides methods to access global or specific business analytics (BA) reports and information.

ba/suppliers/{cid}/{uid}

Administration — Provides administrative tools.

Media — Provides methods to enumerate, get and manage medias: Download and upload files, retrieve images etc.

Urls — Urls to open different objects in Wordbee such as the translation editor.

Translation editor

Settings — Provides methods to retrieve and update platform settings such as languages and task codes.

Applications — Various product tools and applications with their APIs such as MT Hive.

Asynchronous operations — Operations that take more time to execute are most often executed "asynchronously" i.e. in the background. With such operations your API call either immediately returns the final result (if the operation was very quick) or it returns the ID of the operation if executing in the background. The status can then be polled in regular intervals.

Common — This chapter discusses general concepts or mechanisms linked from other pages.

API Best Practices

Change history — The API is evolving fast and new methods or features are added every month.