API: Project management

Last modified: March 03, 2022Author: Jakub Pomykała

Project management API contains two endpoints for creating new projects and listing existing projects.

Using this endpoint requires HTTP Basic authentication with your login credentials (email and password).

If you used GitHub or Google Account to create your account, then you need to set up password for your account in account settings.

POST Create project

https://api.simplelocalize.io/api/v1/projects

Example cURL

curl 
    --location 
    --request POST 'https://api.simplelocalize.io/api/v1/projects' \
    --header 'Authorization: Basic <TOKEN>' \
    --header 'Content-Type: application/json' \
    --data-raw '{
        "name": "My new project"
    }'

Request fields

  • name (required) - project name

Example successful response

{
	"msg": "OK",
	"status": 200,
	"data": {
		"name": "My new project",
		"languages": [
			{
				"key": "en",
				"name": "English",
				"isDefault": false,
				"order": 0
			}
		],
		"projectToken": "<PROJECT_TOKEN>",
		"apiKey": "<PROJECT_API_KEY>",
		"keys": 0,
		"unpublishedChanges": 0,
		"translatedPercentage": 0.0,
		"translatedKeysByLanguage": {}
	}
}

GET List projects

https://api.simplelocalize.io/api/v1/projects

Example cURL

curl 
    --location 
    --request GET 'https://api.simplelocalize.io/api/v1/projects' \
    --header 'Authorization: Basic <TOKEN>'

Example successful response

{
	"msg": "OK",
	"status": 200,
	"data": [
		{
			"name": "My Project Name",
			"languages": [
				{
					"key": "en",
					"name": "english",
					"isDefault": true,
					"order": 0
				}
			],
			"customers": [
                {
                    "key": "my-customer",
                    "description": "My customer description"
                }
			],
			"projectToken": "<PROJECT_TOKEN>",
			"apiKey": "<PROJECT_API_KEY>",
			"keys": 357,
			"unpublishedChanges": 5,
			"translatedPercentage": 0.74,
			"translatedKeysByLanguage": {
				"en": 264
			}
		}
	]
}