This guide shows you, as a Business Account Admin, how to set up API access on a Translayte test environment, create an API key, configure your account API settings, access the Translayte API Documentation, and send a test request to confirm your integration works end to end. By the end of this guide you will have a working API key, a saved API configuration, and a test quote created through the API that you can see in your account.
Initial Setup
Before you can create an API key, three things need to be in place on the test environment. The Translayte team completes these for you:
1. Access to the test environment via Cloudflare. The test environment sits behind Cloudflare Access, so your email address must be granted access before you can open it in your browser.
2. A mock test API account. The Translayte team creates a Business account on the test environment, flagged as a test account, for your API testing.
3. An Admin invitation. The Translayte team invites you as an Admin on the test account. Accept the invitation email to set your password and log in.
That is all that is required for setup. Once you are logged in as an Admin on the test account, create your API key by following the sections below, then proceed with any other tests you require.
Before You Begin
The screenshots in this article were captured on Translayte test environments. The steps and screens are identical on the live platform at translayte.com.
The Translayte API uses two base URLs. Always point test integrations at the Test base URL:
Test: https://translayte.dev/api/v1
Live: https://translayte.com/api/v1
Note: Requests sent to the Live base URL create real quotes, clients, and orders on production. Keep all testing on the Test base URL and use example data only.
Accessing Your API Settings
1. Log in to your Business account, click your account name at the top right of the page, and select Settings from the menu.
2. On the Settings page, click API Settings in the left menu, below Profile, Password, and Addresses.
3. The API Settings page opens on the API Keys tab. If you have not created a key yet, the page shows the message "Create an API key to access the API settings" with a Create API Key button.
Note: The API Documentation link at the top right of the page appears once your account has at least one API key.
Creating an API Key
1. Click Create API Key. The Create API Key window opens with a single API Key Name field.
2. Enter a descriptive name that identifies where the key will be used, for example "Test Integration", then click Create.
3. The window confirms API Key Created and displays your new key once, in full. Click the copy icon next to the key and store it somewhere safe, such as your password manager.
4. Click Done. Your key now appears in the API Keys list with its name and a masked key value.
Note: Copy the key immediately. For security reasons, we cannot show it again. If you lose the key, delete it from the API Keys list and create a new one.
Configuring Your API Settings
1. Click the Settings tab beside API Keys. Four account level options control how API created clients and orders behave:
Restrict pricing and invoice visibility: clients will not be able to see pricing and invoice information on the order page and in emails.
Restrict client from adding shipping: clients will not be able to add shipping to orders on the order page.
Make new clients Active: new clients created via API will be marked as active. They are inactive by default.
Restrict communication from Translayte to clients: the Translayte team will not be able to communicate with clients via email or direct messages. System notifications will also be disabled.
2. Click a toggle to switch it between Disabled and Enabled. In the example below, Restrict communication from Translayte to clients has been switched to Enabled.
3. Click Save. A confirmation message appears: "API settings updated successfully".
Accessing the API Documentation
1. On the API Settings page, click the API Documentation link at the top right. The Translayte API Documentation opens in a new tab.
2. The Overview page lists the Test and Live API Base URLs and explains authentication. The API uses Bearer Auth, so you provide your API key in the Authorization header of every request, for example "Authorization: Bearer 123".
3. The left menu groups the available endpoints: Client, File, Language, MobileAuth, Order, Pricing, Quote, Service, and Shipping.
Sending a Test API Request
1. In the left menu of the API Documentation, expand Quote and select Create a quote for a new client. This POST endpoint at /quotes/create-with-new-client creates a new quote and user account simultaneously for clients who do not have an existing account, which makes it a good end to end test.
2. In the request panel on the right, paste your API key into the Auth Token field.
3. Complete the Body with example values such as the client name, email, phone, locale, service_id, source_language_iso, target_language_iso, quantity, certification_type, country_of_use, and urgency. The Body panel lists each field with its type, requirements, and an example.
4. Click Send API Request. A successful call returns 200 OK with "success": true and a quote object containing the new quote id, its status ("Quote"), the order status description, due date, amount, currency, and pricing information.
Note: This test creates a real quote and a real client account in the test environment. Use example data, such as an example.com email address, so test records are easy to identify and clean up.
Verifying Your Test Quote
1. The new client created by your request receives a quotation email containing a link to the quote page. Open the link, or log in to the new client account and open Orders.
2. The quote page shows the quote exactly as the API created it: the language pair, certification type, quantity, due date, order amount, uploaded documents, and a Make Payment button to accept the quote.
3. If these details match the values you sent in the request body, your API setup is working end to end.
Video Guide - API Test Guide 1.mp4
Kindly reach out to the Translayte sales team ([email protected]) if you need further assistance with setting up your account.
We are excited and looking forward to having you onboard.