Overview
Welcome to the documentation of the Wordbee Translator 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.
This API is work in progress and new methods are added every month. You can find the change history here.
The API 2 endpoint is your Wordbee Translator URL + /api
Please make sure to use the endpoint that applies to your platform throughout this documentation. Read more
Chapters:
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.
- resources/segments/rights
- resources/items
- Search and filter segments
- resources/segments/view
- resources/segments/io
- Export to TMX, EXCEL, CSV, ODS, TBX
- Copy / Consolidate resources
- resources/segments/actions
- resources/segments/finder
- resources/segments/reports
- resources/segments/sampling
- resources/documents
- resources/comments
- resources/timeline
- resources/files
- resources/qa
- Statistics
- resources/team
- resources/list
- Text edits
- Objects - resources
Settings — Provides methods to retrieve and update platform settings such as languages and task codes.
- Languages and codes
- Document formats
- Document format profiles
- Word count profiles
- settings/tbx
- Machine translation
- Custom field configuration
- Segmentation settings (SRX)
- Workflow Templates
- User profiles
- settings/tasks/codes
- settings/currencies/codes
- settings/domains/codes
- settings/countries/codes
- settings/timezones/codes
Common — This chapter discusses general concepts or mechanisms linked from other pages.
- Types
- Objects
- Lists — GETTING STARTED This query searches items in status "1" and with a reference starting with "ax": CODE (POST) */list HTTP BODY: { "query": '{status} = 1 AND {reference}.StartsWith("ax")' } URLS The following methods are available to search, count, print and aggregate your data. Querying data */list Retrieve and query items with all or selected fields. Supports pagination. Parameters like query string, data fields and pagination are included in the request body. Read more */list/full Same as above but systematically includes all data fields in the results. Read more */list/count Same as above but returns just the grand total of jobs matching filter criteria. Read more */list/aggregations Get statistics such as total items per status or other criteria. Gain insight into data. Read more */list/items/{id} Get all fields for a specific item. Read more Field details */list/fields Get list of data fields with name, description, data type and more information. Read more Reports */list/print Download filtered data to EXCEL, XML or JSON. Read more Advanced methods */list/autocomplete Implement auto complete functionality for selected data fields. Read more */list/queries/* Load and save queries for later reuse. Read more */list/layouts/* Load and save list/filter layouts for later reuse. Read more Method Description Documentation ACCESS RIGHTS Please keep in mind that your access rights entirely decide on the data and the field values you can retrieve. With limited rights you may not see all the jobs or projects etc., but just yours. With limited rights you may not see some customer details or other user profile dependent information. Access rights are exactly the same as in the Wordbee Translator system. See also: Access Rights
- Auto-completion and pagination — Many API methods implement optional auto-completion and pagination functionality: