Command Center API Reference

From Lingoport Wiki
Jump to: navigation, search

Introduction

The API commands provide some high level information or actions for individual projects in Command Center. The usage scenario is to get basic information on a project, for instance from a CI/CD system, or to trigger some overall action at the project level or on users.

All API commands require a username and token to authenticate and authorize those calls. API Users are set in the Command Center User Settings panel, and can be added to the Access set of users for a project.

Calls and Returns

Some API calls are to retrieve data, in which case the sections below will show an example of the returned data, otherwise, only the call is described.

Code 200: Success

API calls return a JSON file. Each JSON file as a code entry. When the call succeeds, the code is 200, in the following form:

{ 

 [...]
 "code": 200

}

Errors

API calls may also return errors. For instance, the project below is not associated with an API user, so calls that necessitate a project as input to the different calls may return this error.

The error code follow the HTTP error codes. See:

400: Bad request

For instance, with a badly formatted input JSON in argument

{ 

 "message": "Cannot read payload",
 "code": 400

}

401: Unauthorized

For instance, an API User is incorrect, the call is not authorized. The returned JSON: 

{
  "message": "API user not found",
  "code": 401
}

For instance, with an incorrect token, the returned JSON: 

{
  "message": "Token '*************' does not match",
  "code": 401
}

404: Not found

For instance, the input has the name of a project which does not exist or is not associated with the API user: 

{
  "message": "Project not found. Make sure the API user is set and the project name is spelled correctly.",
  "code": 404
}

API to Retrieve Data

List Command Center projects

The listprojects returns a list of projects associated with the username/token passed in the call. That list may hence not be exhaustive of all the projects on-boarded with Command Center.

The Call

 curl "COMMAND_CENTER_URL/api/listprojects" -d '{"username":"API_USER","token":"API_TOKEN"}'  --header "Content-Type: application/json"

Example: 

 curl "http://localhost:8080/command-center/api/listprojects" -d '{"username":"APIuser","token":"CTMNzj**********CP"}'  --header "Content-Type: application/json"

or 

 curl "https://dockertest2.lingoport.io/command-center/api/listprojects" -d @listprojects.json --header "Content-Type: application/json"

 listprojects.json:
 {
  "username":"APIuser",
  "token":"CTMNzj**********CP"
 }

The Result

The result would look like: 

{
  "projects": [
    "olivierLingoport--simpleProperties--F8829",
    "Lingoport--Figma--B8024",
    "Lingoport--Command-CenterDebug--main",
    "lingoport-public--Rebel-Outfitters--tim"
  ],
  "code": 200
}

Command Center Project Status

The getStatus command provides a high level status on the Globalyzer and the Localyzer side of a given project.

The Call

 curl "COMMAND_CENTER_URL/api/getStatus" -d '{"username":"API_USER","token":"API_TOKEN", "source":{"group_name": "GROUP","project_name": "PROJECT","module_name": "MODULE"}}'  --header "Content-Type: application/json"


Example: 

 curl "http://localhost:8080/command-center/api/getStatus" -d '{"username":"APIuser","token":"CTMNzj**********CP", "source":{"group_name": "Lingoport","project_name": "CET-WorldWindExplorer","module_name": "lili"}}'  --header "Content-Type: application/json"

or 

 curl "http://localhost:8080/command-center/api/getStatus" -d @getStatus.json  --header "Content-Type: application/json"

 getStatus.json: 
 {
    "username":"APIuser",
    "token":"CTMNzj**********CP",
    "source":{
        "group_name": "Lingoport",
        "project_name": "CET-WorldWindExplorer",
        "module_name": ""
     }
 }

The Result

The result would look like: 

{
  "Localyzer": {
    "Kits out for translation": "1 ",
    "Developer Error Number": 0,
    "keys": 1625,
    "words": 5682,
    "words-sent": 113640,
    "words-translated": 113440,
    "words-outstanding": 200
  },
  "Globalyzer": {
    "Embedded Strings": 2,
    "Embedded Strings Density": "0.02%",
    "Locale-Sensitive Methods": 40,
    "Locale-Sensitive Methods Density": "0.46%",
    "Static File References": 3,
    "Static File References Density": "0.03%",
    "General Patterns": 21,
    "General Patterns Density": "0.24%"
  },
  "code": 200
}

Command Center Project Get Locales

The getLocales command provides a JSON output of the source and target locales of a Command Center project.

The Call

 curl "COMMAND_CENTER_URL/api/getLocales" -d '{"username":"API_USER","token":"API_TOKEN", "source":{"group_name": "GROUP","project_name": "PROJECT","module_name": "MODULE"}}'  --header "Content-Type: application/json"


Example: 

 curl "http://localhost:8080/command-center/api/getLocales" -d '{"username":"APIuser","token":"CTMNzj**********CP", "source":{"group_name": "Lingoport","project_name": "CET-WorldWindExplorer","module_name": "lili"}}'  --header "Content-Type: application/json"

or 

 curl "http://localhost:8080/command-center/api/getLocales" -d @getLocales.json  --header "Content-Type: application/json"

 getStatus.json: 
 {
    "username":"APIuser",
    "token":"CTMNzj**********CP",
    "source":{
        "group_name": "Lingport",
        "project_name": "CET-WorldWindExplorer",
        "module_name": "lili"
     }
 }

The Result

The results would look like: 


{
  "projectName": "Lingoport--CET-WorldWindExplorer--lili",
  "sourceLocale": {
    "repositoryLocaleCode": "en-US",
    "localeName": "English (United States)",
    "tmsLocaleCode": "en-US"
  },
  "targetLocales": [
    {
      "repositoryLocaleCode": "sv",
      "localeName": "Swedish (Sweden)",
      "tmsLocaleCode": "sv-SE"
    },
    {
      "repositoryLocaleCode": "tr",
      "localeName": "Turkish (Turkey)",
      "tmsLocaleCode": "tr-TR"
    },
    {
      "repositoryLocaleCode": "no",
      "localeName": "Norwegian Nynorsk (Norway)",
      "tmsLocaleCode": "nn-NO"
    },
    {
      "repositoryLocaleCode": "pl",
      "localeName": "Polish (Poland)",
      "tmsLocaleCode": "pl-PL"
    },
    {
      "repositoryLocaleCode": "fr",
      "localeName": "French (France)",
      "tmsLocaleCode": "fr-FR"
    },
    {
      "repositoryLocaleCode": "cs",
      "localeName": "Czech (Czechia)",
      "tmsLocaleCode": "cs-CZ"
    },
    {
      "repositoryLocaleCode": "ru",
      "localeName": "Russian (Russia)",
      "tmsLocaleCode": "ru-RU"
    },
    {
      "repositoryLocaleCode": "pt-PT",
      "localeName": "Portuguese (Portugal)",
      "tmsLocaleCode": "pt-PT"
    }
  ],
  "code": 200
}

List Command Center Users

The command below lists users by role. Roles are:

  • administrator
  • manager
  • developer
  • translator
  • api

The Call

 curl "COMMAND_CENTER_URL/api/listUsers" -d '{"role": "ROLE","username":"API_USER","token":"API_TOKEN"}'  --header "Content-Type: application/json" -o users.json

Example: 

 curl "http://localhost:8080/command-center/api/listUsers" -d '{"role": "developer","username":"APIuser","token":"CTMNzj**********CP"}'  --header "Content-Type: application/json"

or 

 curl "https://dockertest2.lingoport.io/command-center/api/listUsers" -d @listusers.json --header "Content-Type: application/json"

 listusers.json:
 {
  "role": "developer",
  "username":"APIuser",
  "token":"CTMNzj**********CP"
 }

The Result

The result would look like: 

{
  "users": [
    {
      "id": "4",
      "full_name": "Guest",
      "login_name": "guest",
      "email": "guest@lingoport.com"
    },
    {
      "id": "16",
      "full_name": "Mary Dev",
      "login_name": "maryDev",
      "email": "marydev@lingoport.com"
    }
  ],
  "code": 200
}

Calls to Take Action

This calls only return the JSON file with a code and a message depending on the code.

Command Center Translate

The translate command triggers sending a new prep kit to translation if some strings need to be sent. Some projects may be 100% translated for instance, in which case nothing will be sent to translation. 

 curl "COMMAND_CENTER_URL/api/translate" -d '{"username":"API_USER","token":"API_TOKEN", "source":{"group_name": "GROUP","project_name": "PROJECT","module_name": "MODULE"}}'  --header "Content-Type: application/json"


Example: 

 curl "http://localhost:8080/command-center/api/translate" -d '{"username":"APIuser","token":"CTMNzj**********CP", "source":{"group_name": "Lingoport","project_name": "CET-WorldWindExplorer","module_name": "lili"}}'  --header "Content-Type: application/json"

or 

 curl "http://localhost:8080/command-center/api/translate" -d @translate.json  --header "Content-Type: application/json"

 translate.json: 
 {
    "username":"APIuser",
    "token":"CTMNzj**********CP",
    "source":{
        "group_name": "Lingport",
        "project_name": "CET-WorldWindExplorer",
        "module_name": "lili"
     }
 }

Pseudo-localize a Command Center Project

For Localyzer project with a pseudo-locale configure, the pseudoloc command will create or update the pseudo-localized files from the source locale files and will update the repository with the latest. 


 curl "COMMAND_CENTER_URL/api/pseudoloc" -d '{"username":"API_USER","token":"API_TOKEN", "source":{"group_name": "GROUP","project_name": "PROJECT","module_name": "MODULE"}}'  --header "Content-Type: application/json"


Example: 

 curl "http://localhost:8080/command-center/api/pseudoloc" -d '{"username":"APIuser","token":"CTMNzj**********CP", "source":{"group_name": "Lingoport","project_name": "CET-WorldWindExplorer","module_name": "lili"}}'  --header "Content-Type: application/json"

or 

 curl "http://localhost:8080/command-center/api/pseudoloc" -d @project.json  --header "Content-Type: application/json"

 project.json: 
 {
    "username":"APIuser",
    "token":"CTMNzj**********CP",
    "source":{
        "group_name": "Lingport",
        "project_name": "CET-WorldWindExplorer",
        "module_name": "lili"
     }
 }

Duplicate Command Center Project

The createFromTemplateProject command duplicates an existing project with the same configuration as the source project, on a different repository or branch of a repository. The API user will also be set on that target project as it is part of the source project. 

 curl "COMMAND_CENTER_URLapi/createFromTemplateProject" -d '{"username":"API_USER","token":"API_TOKEN","source": {"group_name": "source_group","project_name": "source_project","module_name": "source_module"},"target": {"group_name":"target_group","project_name": "target_project","module_name": "target_module"}}'  --header "Content-Type: application/json"


  • For Git projects:
    • The target group name is the name of the Git organization
    • The target project name is the name of the Git project in that organization
    • The target module name is the branch of the Git Project in the organization


Example: For a target repository name https://github.com/Lingoport/Command-Center, branch 'liliDev', with a template called Lingoport Command-Center dev in Command Center using https://github.com, the following call would be make: 

 curl "http://localhost:8080/command-center/api/createFromTemplateProject" -d '{"username":"APIuser","token":"CTMNzj**********CP","source": {"group_name": "Lingoport","project_name": "Command-Center","module_name": "dev"},"target": {"group_name":"Lingoport","project_name": "Command-Center","module_name": "liliDev"}}'  --header "Content-Type: application/json"

or 

 curl "COMMAND_CENTER_URLapi/createFromTemplateProject" -d @dupProject.json  --header "Content-Type: application/json"

 dupProject.json:
  {
    "username":"APIuser",
    "token":"CTMNzj**********CP",
    "source":{
        "group_name": "Lingport",
        "project_name": "Command-Center",
        "module_name": "dev"
     },
     "target": {
         "group_name":"Lingoport",
         "project_name": "Command-Center",
         "module_name": "liliDev"
      }
  }

The dupProject.json file can be used for all the commands. Only the required values will be used.


Add Users to a Team

The command below add users to a team, via their IDs. 

 curl "COMMAND_CENTER_URL/api/addUsersToTeam" -d '{"team": "TEAM","username":"API_USER","token":"API_TOKEN","userList":"COMMA SEPARATED LIST OF IDs"}'  --header "Content-Type: application/json" -o users.json

Example: 

 curl "http://localhost:8080/command-center/api/addUsersToTeam" -d '{"team": "Dev","username":"APIuser","token":"CTMNzj**********CP", "userList":"4,5,7,19"}'  --header "Content-Type: application/json"

or 

 curl "https://dockertest2.lingoport.io/command-center/api/addUsersToTeam" -d @userAssignment.json --header "Content-Type: application/json"

 userAssignment.json:
 {
   "team":"Dev",
   "username":"APIuser",
   "token":"9VwxxxxxxxxP14",
   "userList": "4,16"
 }

Note: Removing users from a team or managing users at large is better done via the Command Center user interface, not via an API call.

Retrieved from "http://wiki.lingoport.com/index.php?title=Command_Center_API_Reference&oldid=99034"