Documentation
API
Locale API
The Locale API is composed of 2 endpoints:
- Add Locale — add a new locale or language to a project
- Delete Locale — delete a locale or language from a project
Add Locale
This endpoint is only accessible by the read-write Project API key and is used to add a locale to a project.
/api/projects/:project_token/locales [POST]
Parameters:
id: the locale code (en-US,en_GBorfrfor instance).suffix_code: Optional, the suffix code (pirateordevfor instance). This will let you create a custome locale (en-pirateoren-devfor intance).suffix_description: Optional, the description of the suffix (pirateordevelopersfor instance).parent_locale_code: Optional, ISO code of the parent locale for language inheritance (only works if the organization plan supports language inheritance).
If everything goes well, the server should respond with 202 Accepted in the response headers. Please note that the request could be acted upon since the rest of the process (creating language files for that locale) is processed in the background on WebTranslateIt’s server. Besides, these new files might not immediately be available.
The parameters are sent as a form body, not as JSON.
/api/projects/:project_token/localescurl -X POST "https://webtranslateit.com/api/projects/PROJECT_TOKEN/locales" \
-d "id=fr"
await fetch(
'https://webtranslateit.com/api/projects/PROJECT_TOKEN/locales',
{
method: 'POST',
body: new URLSearchParams({ id: 'fr' })
}
)
import requests
requests.post(
"https://webtranslateit.com/api/projects/PROJECT_TOKEN/locales",
data={"id": "fr"},
)
require 'net/http'
uri = URI('https://webtranslateit.com/api/projects/PROJECT_TOKEN/locales')
Net::HTTP.post_form(uri, 'id' => 'fr')
<?php
$ch = curl_init('https://webtranslateit.com/api/projects/PROJECT_TOKEN/locales');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query(['id' => 'fr']));
curl_exec($ch);
curl_close($ch);
Delete Locale
This endpoint is only accessible by the read-write Project API key and is used to delete a locale from a project.
/api/projects/:project_token/locales/:locale_code [DELETE]
If everything goes well, the server should respond with 202 Accepted in the response headers. Please note that the request could be acted upon since the rest of the process (deleting locale, linguistic files and translations for that locale) is processed in the background on WebTranslateIt’s server.
/api/projects/:project_token/locales/:locale_codecurl -X DELETE "https://webtranslateit.com/api/projects/PROJECT_TOKEN/locales/fr"
await fetch(
'https://webtranslateit.com/api/projects/PROJECT_TOKEN/locales/fr',
{ method: 'DELETE' }
)
import requests
requests.delete(
"https://webtranslateit.com/api/projects/PROJECT_TOKEN/locales/fr"
)
require 'net/http'
uri = URI('https://webtranslateit.com/api/projects/PROJECT_TOKEN/locales/fr')
Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
http.request(Net::HTTP::Delete.new(uri))
end
<?php
$ch = curl_init('https://webtranslateit.com/api/projects/PROJECT_TOKEN/locales/fr');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_exec($ch);
curl_close($ch);