Lokalise API 2.0 official Node.js client

Lokalise lets you manage translations of your app, game or website – either on your own or with a team of collaborators.

Lokalise API documentation

Wrapper's Documentation

Getting started

npm install @lokalise/node-api

const { LokaliseApi } = require('@lokalise/node-api');

const lokaliseApi = new LokaliseApi({ apiKey: '<apiKey>'});

const projects = await lokaliseApi.projects.list();

Usage

Every request returns a promise with a corresponding object (or array of objects) as the result.

Table of Contents generated with DocToc

• Projects
  • List projects
  • Create project
  • Destroy project
  • Update project
• Comments
  • List project comments
  • List comments
  • Get a comment
  • Create project comments
  • Destroy a comment
• Contributors
  • List project contributors
  • Get a project contributor
  • Create a project contributor
  • Delete a project contributor
• Files
  • List project files
  • Upload a file
  • Download a file
• Keys
  • List project files
  • Upload a file
  • Download a file
• Keys
  • List project keys
  • Create project keys
  • Update a key
  • Update keys bulk
  • Destroy a key
  • Destroy keys
• Languages
  • List system languages
  • List project languages
  • Create project language
  • Get a project language
  • Update a project language
  • Delete a project language
• Screenshots
  • List screenshots
  • Create screenshots
  • Get a screenshot
  • Update a screenshot
  • Delete a screenshot
• Snapshots
  • List snapshots
  • Create a snapshot
  • Restore a snapshot
  • Delete a snapshot
• Tasks
  • List tasks
  • Create a task
  • Get a task
  • Delete a task
• Teams
  • List teams
• Team users
  • List team users
  • Get a team user
  • Update a team user
  • Delete a team user
• Team user group
  • List team user group
  • List team user group
  • Get a team user group
  • Add project to a group
  • Remove a project from a group

Projects

List projects

Parameters page or limit are optional.

lokaliseApi.projects.list({ page: 1, limit: 1000 });

Create project

lokaliseApi.projects.create({ name: "Project name", description: "Project description" });

Destroy project

lokaliseApi.projects.delete(projectId);

Update project

lokaliseApi.projects.update(<projectId>, { name: "New name", description: "New description"});

Comments

List project comments

You should pass projectId as a parameter.

lokaliseApi.comments.list_project_comments({ project_id: <projectId>});

List key comments

You should pass projectId and keyId as parameters.

lokaliseApi.comments.list_project_comments({ project_id: <projectId>, key_id: <keyId>});

Get a comment

You should pass commentId, projectId and keyId as parameters.

lokaliseApi.comments.get(<commentId>, { project_id: <projectId>, key_id: <keyId>});

Create project comments

Returns promise array of comments.

lokaliseApi.comments.create({ 
  'comments': [
      { comment: "Project comment 1" },
      { comment: "Project comment 2" }
    ],
    { project_id: '<projectId>', key_id: '<keyId>'});

Destroy a comment

lokaliseApi.comments.delete(<commentId>, { project_id: <projectId>, key_id: <keyId> });

Contributors

List project contributors

You should pass projectId as a parameter.

lokaliseApi.contributors.list({ project_id: <projectId> });

Get a contributor

You should pass contributorId and projectId as parameters.

lokaliseApi.contributors.get(<contributorId>, { project_id: <projectId> });

Create a contributor

You should pass contributors object and projectId as parameters.

lokaliseApi.contributors.get({
                "contributors": [
                    {
                        "email": "translator@mycompany.com",
                        "fullname": "Mr. Translator",
                        "is_admin": false,
                        "is_reviewer": true,
                        "languages": [
                            {
                                "lang_iso": "en",
                                "is_writable": false
                            },
                            {
                                "lang_iso": "ru",
                                "is_writable": true
                            }
                        ],
                        "admin_rights": [
                            "keys", "languages"
                        ]
                    }
                ]
            },

            { project_id: <projectId>, key_id: <key_id>});

Delete a contributor

You should pass contributorId and projectId as parameters.

lokaliseApi.contributors.delete(<contributorId>, {project_id: <projectId>});

Files

List project files

Parameters page or limit are optional.

lokaliseApi.files.list({ project_id: <projectId>, page: 1, limit: 1000 });

Upload a file

lokaliseApi.files.upload(<projectId>, {
        "filename": "index.json",
        "data": "D94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGL.....",
        "lang_iso": "en",
        "tags": [
            "index", "admin", "v2.0"
        ],
        "convert_placeholders": true
      }
    });

Download a file

lokaliseApi.files.download(<projectId>, {
    "format": "json",
    "original_filenames": true
});

Files

List project files

Params page and limit are optional.

lokaliseApi.files.list({ project_id: <projectId>, page: 1, limit: 1000 });

Upload a file

lokaliseApi.files.upload(<projectId>, {
        "filename": "index.json",
        "data": "D94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGL.....",
        "lang_iso": "en",
        "tags": [
            "index", "admin", "v2.0"
        ],
        "convert_placeholders": true
      }
    });

Download a file

lokaliseApi.files.download(<projectId>, {
    "format": "json",
    "original_filenames": true
});

Keys

List project keys

lokaliseApi.keys.list({project_id: <projectId>, page: 1, limit: 1})

Create keys

lokaliseApi.keys.create({
    "keys": [
        {
            "key_name": "index.welcome",
            "description": "Index app welcome",
            "platforms": [
                "web"
            ],
            "translations": [
                {
                    "language_iso": "en",
                    "translation": "Welcome"
                }
            ]
        },
        {
            "key_name": "index.apple",
            "description": "Welcome apple",
            "platforms": [
                "web"
            ],
            "is_plural": true,
            "translations": [
                {
                    "language_iso": "en",
                    "translation": {
                        "one": "I have one apple",
                        "other": "I have a lot of apples"
                    }
                }
            ]
        },
        {
            "key_name": "index.hello",
            "platforms": [
                "web"
            ]
        }
    ]
}, 

{project_id: <projectId, page: 1, limit: 1>});

Update a key

lokaliseApi.keys.update(<keyId>, {
    "platforms": [
        "web","other"
    ],
    "description": "Index app welcome"
},

{ project_id: <projectId> });

Update keys in bulk

lokaliseApi.keys.bulk_update({
    "keys": [
        {
            "key_id": 331223,
            "key_name": "index.welcome",
            "description": "Index app welcome",
            "platforms": [
                "web"
           ]
        },
        {
            "key_id": 331224,
            "key_name": "index.hello",
            "description": "Index greetings",
            "platforms": [
                "web"
           ]
        }
    ]
}, { project_id: <projectId>});

Destroy a key

lokaliseApi.keys.delete(<keyId>, { project_id: <projectId> });

Destroy keys

lokaliseApi.keys.bulk_delete({
        "keys": [
            12345, 12346
        ]
    }, { project_id: <projectId> });

Languages

List system languages

lokaliseApi.languages.system_languages({page: 1, limit: 10000})

List project languages

lokaliseApi.languages.list({project_id: <projectId>});

Create a language

lokaliseApi.languages.create({
      "languages": [
          {
              "lang_iso": "en"
          },
          {
              "lang_iso": "ru"                        
          }
      ]},
      { project_id: <projectId> });

Get a language

lokaliseApi.languages.get(<languageId>, { project_id: <projectId> });

Update a language

lokaliseApi.languages.update(<languageId>, {
          "lang_iso": "en-US",
          "plural_forms": [
              "one", "zero", "few", "other"
          ]
      }, {project_id: <projectId>});

Delete a language

lokaliseApi.languages.delete(<languageId>, { project_id: <projectId> });

Screenshots

List screenshots

lokaliseApi.screenshots.list({project_id: <projectId>});

Create screenshots

lokaliseApi.screenshots.create({
        "screenshots": [
            {
                "data": "data:image/jpeg;base64,D94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGL.....",
                "ocr": false,
                "key_ids": [
                    1132290, 1132292, 1132293
                ],
                "tags": [
                    "onboarding"
                ]
            }
        ]
    }, {project_id: <projectId>});

Get a screenshot

lokaliseApi.screenshots.get(<screenshotId>, {project_id: <projectId>});

Update a screenshot

lokaliseApi.screenshots.update(<screenshotId>, {
    "key_ids": [
        1132290, 1132292
    ],
    "tags": [
        "main"
    ]
}, {project_id: <projectId>});

Delete a screenshot

lokaliseApi.screenshots.delete(<screenshotId>, { project_id: <projectId> });

Snapshots

List snapshots

lokaliseApi.screenshots.list({project_id: <projectId>});

Create a snapshot

lokaliseApi.screenshots.create({ "title": "API snapshot" }, {project_id: <projectId>});

Restore a snapshot

lokaliseApi.screenshots.restore({ project_id: <projectId>, id: <snapshotId>});

Delete a snapshot

lokaliseApi.screenshots.delete({ project_id: <projectId>, id: <snapshotId>});

Tasks

List tasks

lokaliseApi.tasks.list({project_id: <projectId>});

Create a task

lokaliseApi.tasks.create({
    "title": "Voicemail messages",
    "description": "Need your help with some voicemail message translation. Thanks!",
    "due_date": "2018-12-31 12:00:00 (Etc\/UTC)",
    "keys": [
        11212, 11241, 11245
    ],
    "languages": [
        {
            "language_iso": "fi",
            "users": [
                421
            ]
        },
        {
            "language_iso": "ru",
            "groups": [
                191
            ]
        }
    ],
    "auto_close_languages": true,
    "auto_close_task": true,
    "task_type": "translation",
    "parent_task_id": 12345,
    "closing_tags": ["tag_one", "tag_two"],
    "do_lock_translations": true
}, {project_id: <projectId>});

Get a task

lokaliseApi.tasks.get(<taskId>, { project_id: <projectId> });

Delete a task

lokaliseApi.tasks.delete(<taskId>, { project_id: <projectId>});

Teams

List all teams

lokaliseApi.teams.list({ page 1, limit: 10000 });

Team users

List team users

lokaliseApi.team_users.list({project_id: <projectId>});

Get a team user

lokaliseApi.team_users.get(<teamUserId>, { project_id: <projectId> });

Update a team user

lokaliseApi.team_users.update(<teamUserId>, { "role": "admin" },
                        { project_id: <projectId> });

Delete a team user

lokaliseApi.team_users.delete(<teamUserId>, { project_id: <projectId> });

Team user groups

List team user groups

lokaliseApi.user_groups.list({ team_id: <teamId> });

Create a team user group

lokaliseApi.user_groups.create({
      "name": "Proofreaders",
      "is_reviewer": true,
      "is_admin": false,
      "admin_rights": [],
      "languages": {
          "reference": [],
          "contributable": [640]
      }
  }, { team_id: <teamId> });

Get a team user group

lokaliseApi.user_groups.get(<groupId>, { team_id: <teamId> });

Add project to a group

lokaliseApi.user_groups.add_project_to_group(<teamId>, <groupId>, {
                          "projects": [
                              "598901215bexxx43dcba74.xxx"
                          ]
                      });

Remove a project from a group

lokaliseApi.user_groups.remove_project_from_group(<teamId>, <groupId>, {
                          "projects": [
                              "598901215bexxx43dcba74.xxx"
                          ]
                      });