Authentication
Localize exposes much of its functionality the Localize API to make it is easier for you to automate your workflow and integrate Localize with your existing tools.
Localize API calls are REST compliant and make use of the most common HTTP methods such as GET, POST, PUT and DELETE.
Authentication
Localize only allows authenticated requests to the API over HTTPS.
HTTPS requests only
Calls made over plain HTTP will fail.
API requests without authentication will also fail. Authenticate your account when using the API by including your API key in the request. Your API keys carry many privileges, so be sure to keep them secret. Don’t share them with other users or store them in insecure places. Provide your API key as the basic auth username value.
To authenticate with the API, provide your Public Key as the bearer value in the authentication header. Please treat both your Public and Private keys as secrets. Do not share these keys, and do not store either key in insecure locations.
curl https://api.localizejs.com/v2.0/projects
-H 'Authorization: Bearer sdjfh4G58cJ89234Lfj123ndfbknG'
-H 'Content-Type: application/json'
Obtaining an API token
To get an API token, complete the following steps.
- Log into to your Localize account.
- Navigate to the developer API keys section of settings.
- Generate an API token
- Use the Public Key as the Bearer value.
API Public Key Warning
The Public Key should be treated as a secret and not shared publicly
Schema
All data is sent and received as JSON, and requests sent to the API as JSON must have the correct content type header: Content-Type: application/json.
Blank or empty fields are included as null instead of being omitted. All timestamps are returned in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Endpoint
The Localize API is a restful http service. All requests to Localize must be made using https against the following URL:
https://api.localizejs.com/v2.0/
Errors
Localize uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a translation failed, etc.), and codes in the 5xx range indicate an error with Localize's servers.
Example
"meta": {
"status": 400,
"success": false,
"error": {
"message": "[type] The type is required"
}
}Get a phrase
Get a specific phrase