Do you prefer to integrate the locize api on your own?
No problem! If you want to make a low level integration or just did not found an appropriate client library here you find our simple api description or you can access API via:
$ curl -X GET https://api.locize.app/3d0aa5aa-4660-4154-b6d9-907dbef10bb2/production/en/landingpage
2
# will return something like:
3
# {
4
# "Average App": "Average App",
5
# "Benefits": "Benefits",
6
# "Blog": "Blog",
7
# ...
8
# "privacy policy": "privacy policy",
9
# "terms of service": "terms of service"
10
# }
Copied!
(You can find your projectId in your project settings under the API Tab.)
Each of these requests counts as download for your next invoice.
Fetch private namespace resources
Some projects have a higher demand for privacy. To accomplish this, you can set your versions to publish in private mode which means you will need an API key to fetch your namespace resources.
It's a simple HTTP GET request with this url pattern:
(You can find your projectId and API Key in your project settings under the API Tab.)
Each of these requests counts as private download for your next invoice.
Fetch the available languages
You have the possibility to ask locize which languages are available for a particular project. That way you can have a dynamic language selector.
It's an even simpler HTTP GET request with this url pattern:
https://api.locize.app/languages/{projectId}
example:
1
$ curl -X GET https://api.locize.app/languages/3d0aa5aa-4660-4154-b6d9-907dbef10bb2
2
# will return something like:
3
# {
4
# "en": {
5
# "name": "English",
6
# "nativeName": "English",
7
# "isReferenceLanguage": true,
8
# "translated": {
9
# "latest": 1,
10
# "production": 1
11
# }
12
# },
13
# "de-CH": {
14
# "name": "German",
15
# "nativeName": "Deutsch",
16
# "region": "CH",
17
# "isReferenceLanguage": false,
18
# "translated": {
19
# "latest": 1,
20
# "production": 0.521
21
# }
22
# },
23
# "it": {
24
# "name": "Italian",
25
# "nativeName": "Italiano",
26
# "isReferenceLanguage": false,
27
# "translated": {
28
# "latest": 1,
29
# "production": 1
30
# }
31
# },
32
# ...
33
# }
Copied!
​
Advice:
This request has a minimum cache duration of 1 hour.
(You can find your projectId in your project settings under the API Tab.)
Missing translations
You can say to locize that some translations are missing. For example this is very useful in development. This will not replace an existing translation.
This is a little bit more advanced. It's a HTTP POST request with this url pattern:
Translations not defined in your reference language will not be shown in the locize app.
You should post missing translation to the reference language first!
If you send more than 1000 keys , you have to page your request.
If you get a 412 status code, this means it was an unnecessary request and nothing was missing.
(You can find your projectId and API Key in your project settings under the API Tab.)
You should not use this endpoint in production.Read this guide before you're going to production.
Used translations
You can say to locize which translations are used. Locize will then remember at which time the translations have been last used. For example this is very useful in development. For example during an e2e test you can spot which translations are probably not used anymore.
This is also a HTTP POST request, with this url pattern:
If you send more than 1000 keys , you have to page your request.
(You can find your projectId and API Key in your project settings under the API Tab.)
You should not use this endpoint in production.Read this guide before you're going to production.
Update/Remove translations
You can say to locize that some translations should be updated or deleted. For example this is very useful for an integration from an other already existing system to slowly transition the translations to locize.
This is also a little bit more advanced. It's a HTTP POST request with this url pattern:
By providing the appropriate API key as bearer token you can also retrieve information about your private namespace resources. (if using the private publishing feature)
(You can find your projectId and API Key in your project settings under the API Tab.)
You should not use this endpoint in production.
If you need to know the lastModified timestamp of a specific namespace, you should parse the last-modified header in the Fetch namespace resources response.
Fetch/filter the (unpublished) namespace resources
Sometimes in your localization process you want to know which are the translations that are approved by your reviewer. Assuming you have defined some tags to mark translations as approved, with this api you're able to filter by these tags.
This is pretty easy. It's a simple HTTP GET request with this url pattern:
with positive tags filter: https://api.locize.app/pull/{projectId}/{version}/{language}/{namespace}?tags=[0,2] (you need to pass the tag index)
in combination with a negative tags filter: https://api.locize.app/pull/{projectId}/{version}/{language}/{namespace}?tags=[0,2]&!tags=[1]
Another use case could be to track the amount of words changed during a time period. To do this, you can pull the translations at period 1, save this state and the current timestamp and later at period 2 you can pull again with an additional filter.
i.e. get all translations updated after 2017-12-06T19:42:18.139Z (UTC): https://api.locize.app/pull/{projectId}/{version}/{language}/{namespace}?updatedAt=>1512589338139 (number of milliseconds since 1970/01/01)
i.e. get all translations updated before 2017-12-06T19:42:18.139Z (UTC): https://api.locize.app/pull/{projectId}/{version}/{language}/{namespace}?updatedAt=<1512589338139
Additionally another use case could be to remove unused translations. (This is only possible if you make use of the Used translations endpoint) To do this, you can pull the translations with an additional filter.
i.e. get all translations used after 2017-12-06T19:42:18.139Z (UTC): https://api.locize.app/pull/{projectId}/{version}/{language}/{namespace}?lastUsed=>1512589338139 (number of milliseconds since 1970/01/01)
i.e. get all translations used before 2017-12-06T19:42:18.139Z (UTC): https://api.locize.app/pull/{projectId}/{version}/{language}/{namespace}?lastUsed=<1512589338139
(You can find your projectId and API Key in your project settings under the API Tab.)
Copy version
If you are using multiple versions of your translations you can ask locize to copy (replace) all translations from one version to the other. For example this is very useful when you release your translation files from one version to the other via your custom tooling. It's the same behavior like Overwriting via the UI.
This is easy. It's a HTTP POST request without body with this url pattern:
(You can find your projectId and API Key in your project settings under the API Tab. Keep in mind to use the API Key for {toVersion})
Publish version
If you want to fully automate your CI/CD pipeline by publishing a version exactly at the same time when you deploy a new version of your product this api call is exactly what you are looking for.
This is very easy. It's a HTTP POST request without body with this url pattern:
(You can find your projectId and API Key in your project settings under the API Tab.)
​
Sometimes you want to automate even more. I.e if you want to create your own translation management ui. The following endpoints are probably what you are looking for.
(You can find your projectId and API Key in your project settings under the API Tab.)
Invite new users
https://api.locize.app/invite/{projectId}
The body contains
email the user's email address
role can be "user" or "publisher" or "admin" (default: "user")
scope is an object describing a scope restriction (default: empty arrays for languages and versions)
To skip sending the email automatically set the query parameter send to false. This will not send any email. This way you can send the invitation mail by your own, if you want to.