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:

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.
  • projects/list
  • projects/{pid}/wordcounts/{did}/{trg}
  • projects/{pid}/wordcounts/{did}/{trg} (PUT)
  • projects/{pid}/wordcounts/{did}/{trg}/report
  • projects/{pid}/locales
  • projects/{pid}/settings/workflow
  • projects/{pid}/settings/workflow (PUT)
  • projects/{pid}/archival/*
  • Working offline
• Jobs — Provides methods to enumerate and manage jobs.
  • jobs/list
  • jobs/{id}/summary
  • jobs/{id}/properties (post)
  • jobs/{id}/action/commit
  • jobs/{id}/action/reassign-person
  • jobs/{id}/supplier (post)
  • Job Cost
  • Job Word Counts
  • Job Terms & Conditions
  • Job Traces
  • Common - Jobs — Common data structures related to jobs.
• Workflows
  • Submit New Files
  • Enumerate Workflows
  • Use Workflow Webhooks
  • Get Workflow Status
  • Download Deliverables
  • Confirm Delivery
  • Manage attachments
• 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
• Persons — API methods to retrieve or update information related to persons (users).
  • persons/list
  • persons/{uid}
  • persons/labels
  • persons/{uid}/calendar/view
  • persons/{uid}/calendar/week
  • Updating and importing persons
  • Person domains
  • Person settings
• Companies — API methods to retrieve or update information related to companies: my company, supplier companies, client companies.
  • companies/list
  • companies/{cid}/calendar/view
  • companies/{cid}/calendar/week
  • companies/{cid}/notes
  • companies/{cid}/location/googlemaps
  • Company domains
• Invoices — This section describes invoice related methods: Find invoices. View details, update details, delete invoices.
  • invoices/list
  • invoices/items/{id}
  • invoices/items/{id}/status
  • invoices/items/{id}/status/{status} (PUT)
  • invoices/items/{id} (PUT)
  • invoices/items/new/clientinvoice
  • invoices/items/new/aggregation
  • invoices/items/{id} (DELETE)
  • Invoice Objects
• Services
  • Introduction to services
  • Company services
  • Person services
  • Supplier groups
• Orders
  • orders/list
  • Order status and messages
  • Order status
  • orders/{orderId} (DELETE)
  • orders/create (POST)
  • orders/{orderId}/workprogress
  • Order file management
  • orders/create (post) - DEPRECATED
• Business Reports
  • businessreports/list
  • businessreports/reports/{id}/create
  • businessreports/categories
  • businessreports/uilocales
  • businessreports/reports/{id}/pin (GET)
  • businessreports/reports/{id}/pin (PUT)
• Business Analytics — Provides methods to access global or specific business analytics (BA) reports and information.
  • ba/suppliers/{cid}/{uid}
• Administration — Provides administrative tools.
  • admin/activity/users
  • admin/logs/traces/{day}
  • admin/logs/traces/last/{minutes}
  • admin/logs/traces/range
  • Traces
  • Trace details
  • Apis
• Media — Provides methods to enumerate, get and manage medias: Download and upload files, retrieve images etc.
  • media/company
  • media/get/{token}
  • media/get/{token}/stream
  • media/upload
  • media/upload/multi
  • media/user
  • media/filescollection
• 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.
  • 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
• Applications — Various product tools and applications with their APIs such as MT Hive.
  • CMS Integration
  • Wordbee Flex Workflows
  • MT Hive
  • Microsoft Power-BI
  • Toolbox
• 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.
  • trm/status
  • trm/cancel
  • trm/list
  • Callbacks (with asynchronous operations)
• Common — This chapter discusses general concepts or mechanisms linked from other pages.
  • Types
  • Objects
  • Lists — GETTING STARTED
  • Auto-completion and pagination — Many API methods implement optional auto-completion and pagination functionality:
• API Best Practices
• Change history — The API is evolving fast and new methods or features are added every month.