Development Guidelines


Note: If your Connector will need to support extra complexity of submitting jobs to one of multiple providers please contact support to discuss the best practice.

Review these guidelines to ensure that the first version of your Connector will:

  • have the features required for a production environment
  • meet the Lionbridge Connector Certification requirements

After you develop your Connector, the Lionbridge Connector team will use these guidelines as the basis to certify it.

Best practices in Connector development
Best Practice Explanation
Implement a catch-and-retry for 50x or 429 (throttling) errors from the API, with an exponential back-off retry interval. This increases the reliability of the integration. Occasionally, the API can experience load spikes that require additional system resources. The back end is designed to scale up when these are detected. However, there may be a delay before these capacities are available. There is also a rate throttling limit for API requests that users can hit when making a lot of API requests in a short amount of time.
Introduce a slight delay between method invocations when iterating over a large number of jobs or requests. This smooths out the load spikes.

Set the Accept request-header field to the expected response content type, when retrieving the translated file from the API. For most use cases, setting the field to application/octet-stream will suffice.

This prevents the situation of receiving a base64 string instead of the expected translated file.
Enable mashing payload files together. This avoids hundreds of files in a single payload file.
Retrieve at the job level (as opposed to the file level).  
Use the LL-CC format for the language codes, listed in Supported language codes.  
Validate your language list. This prevents a situation where you programmed pt-br, but you intended to program pt-pt.
Create as much business logic within the Connector as possible. For example, with job approval, ensure that after delivery the translated content does not become publicly available until after a user reviews and accepts it. This can be configurable by the user.
Connectors should include a User Guide and an Installation Guide for effective support post deployment. Documentation enables users to be self-sufficient.
What’s Next?
If you have any questions about the process or the best practices described this document... If you have any questions during the development process... After you have developed your Connector...
Please email to contact the Lionbridge Connector Team.
We can set up a call with you. We can answer your questions.

Request a certification meeting with Lionbridge to certify the Connector for production use.

Note: Certification is required before Production access is granted.