You’ve tested on the sandbox. Your code is ready. You’re ready to start sending your content to be human-translated.

Before you do, make sure you’ve done the following before going live:

✔ Follow the Gengo API workflow

  • Submit text for translation, get order status, and retrieve completed translations. See the Visual Guide for more information.

✔ Triple brackets are used on texts you do not need translated

  • Triple brackets are useful to make sure certain texts, such as brand names, are preserved. Learn more
  • Note: HTML tags are an exception to this rule. You should not have to bracket these

✔ Use the “position” parameter (starting at 1) for each job in the request

  • Using the position parameter makes sure the translator sees your strings in the order they were meant to be seen/read

✔ Provide context for translators

  • Providing additional context betters translation quality and speeds up delivery
  • Order-level comments can be used for instructions, style guides, or links to external documents that provide additional context.
  • The “attachments” param is a great way to send images for context

✔ Use the "custom_data" parameter, not “callback_url” or “slug” for internal information reference

  • Data that can help connect information in your system to a job should be inserted in “custom_data”

✔ Use the "callback/webhook" functionality to receive notifications about the project

  • This is an easy way to get updates when your orders change status. You can learn more about when these callbacks are sent here

✔ Have a way to poll for updates using the GET /translate/order/{id}/ endpoint

  • Due to network issues, callbacks must not be relied upon entirely. Make sure to periodically poll for jobs to stay updated with your translations’ statuses
  • Using the job IDs in the response, you can then retrieve the available translations using the GET /translate/jobs/{ids}/ endpoint as per the Visual Guide

✔ Have the option to approve, reject, or return the jobs for corrections using the PUT /translate/jobs/ endpoint

  • Only use “auto_approve = 1” if you are working with trusted or preferred translators. By getting the job approved, you acknowledge that you are happy with the translation, and thus forfeit your right to refunds or retranslations requests.

Got them all? Then you’re ready to deploy!

Have more questions? Submit a request


Article is closed for comments.
Powered by Zendesk