本地化API 2.0文档

开始

Lokalise API v2是围绕着休息. API具有面向资源的URL，并使用HTTP响应代码指示API错误。

JSON由所有API响应返回，包括错误。

有Lokalise CLI v2作为所有端点的包装器。您可以下载针对不同平台的预编译二进制文件。

客户端库

官方的Lokalise PHP客户机．

官方的Lokalise Ruby接口．

官方的Lokalise node . js库．

官方的Lokalise Golang客户．

官方的Lokalise Python接口．

官方的Lokalise Elixir接口．

身份验证

通过提供API令牌作为请求头来认证您的帐户X-Api-Token. 令牌可以在您的下生成个人资料- - - - - - API的令牌。用户必须在项目中具有Admin角色，才能使用提供的令牌访问项目。

所有API请求都必须通过HTTPS进行。通过普通HTTP进行的调用将会失败。没有身份验证的API请求也会失败。

请求200

标题

X-Api-Token: f4d3f29bf893dc3583e9970735e08de094e82b0

分页

所有顶级API资源都支持通过列表API方法。例如，您可以列出语言、贡献者或翻译。

这些列表API方法共享一个共同的结构，至少有以下两个参数:限制和页面．

的限制默认是One hundred.，最大限度5000和页面默认是1．

每个列表方法包括一个X-Pagination-Total-Count头，可用条目的总数和X-Pagination-Page-Count具有可用页面总数的页眉。

利率限制

对所有端点的访问将被限制为每秒6次请求从2021年9月14日- 不会有任何额外的宽限期。每个API令牌和每个IP地址应用此限制。如果超出限制，将以JSON格式返回429 HTTP状态代码：

{"message": "请求太多。"details": "See //www.wwealerts.com/api2docs/curl/#resource-rate-limits for more information on API request rate limits."｝

每个令牌只允许一个并发请求。

分支

如果您使用的是project分支在Lokalise中的功能，只需将分号分隔的分号添加到任何端点中的项目ID，以访问分支，即3002780358964 f9bab5a92.87762498:功能/新书．

分支机构

分支的对象

属性

branch_id

数字

分支的唯一标识符。
的名字

字符串

分行名称。
created_at.

字符串

分支机构的日期。
created_at_timestamp

数字

创建分支时的Unix时间戳。
由...制作

数字

创建分支的用户的标识符。
created_by_email

字符串

创建分支的用户的电子邮件。

列出所有分支机构

检索分支列表。

Url参数

限制

字符串

默认值：100

要包括的项目数量(最多5000)。
页面

字符串

默认值：1

返回从该页开始的结果。

定义

         得到
         https://api.lokalise.com/api2/projects/{project_id}/分支机构
        

示例请求

curl——request GET \
——https url:/ / api.lokalise.com/api2/projects/ \ {project_id} /分支--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

标题

X-Total-Count: 2

身体

｛“项目id”：“20008339586 cded200e0d8.29879849”，“分支”: [{“branch_id”：1234，“名称”：“功能/最好的web”，“created_at”：“2019-10-01 14:16:00（etc / utc）”，“created_at_timestamp”：1567001760，“created_by”：1123，“created_by_email”："john@lokalise.com"}，{“branch_id”：5678，“名称”：“热修复补丁/ error1”，“created_at”：“2019-10-0214:15:50（Etc/UTC）”，“created_at_timestamp”：1567001750，“created_by”：1123，“created_by_email”："john@lokalise.com"}]}

检索一个分支

检索分支对象。

定义

         得到
         https://api.lokalise.com/api2/projects/{project_id}/部门/{branch_id}
        

示例请求

curl——request GET \
——https url://api.lokalise.com/api2/projects/ {project_id} / branches/ {branch_id} \--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

｛“项目id”：“600904245C4ECF0EC4A9D4.28360690”，“分支”:{“branch_id”：5678，“名称”：“热修复补丁/ error1”，“created_at”：“2019-10-0214:15:50（Etc/UTC）”，“created_at_timestamp”：1567001750，“created_by”：1123，“created_by_email”："john@lokalise.com"}}

创建分支

在项目中创建分支。需要管理员权限。

属性

的名字

字符串

分行名称。

定义

         帖子
         https://api.lokalise.com/api2/projects/{project_id}/分支机构
        

示例请求体

｛“名称”：“热修复补丁/很重要”｝

示例请求

curl——请求发布\
——https url:/ / api.lokalise.com/api2/projects/ \ {project_id} /分支--标题“application / json内容类型:＼
--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”＼
——数据{“名称”:“热修复补丁/很重要”}”

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“分支”:{“branch_id”：995991，“名称”：“热修复补丁/很重要”，“created_at”：“2019-10-03 14:15:50(等/ UTC)”，“created_at_timestamp”：1567001750，“created_by”：1123，“created_by_email”："john@lokalise.com"}}

更新分支

更新项目中的一个分支。需要管理。

属性

的名字

字符串

分行名称。

定义

         把
         https://api.lokalise.com/api2/projects/{project_id}/部门/{branch_id}
        

示例请求体

｛“名称”：“热修复补丁/ needed-yesterday”｝

示例请求

curl——request PUT \
——https url://api.lokalise.com/api2/projects/ {project_id} / branches/ {branch_id} \--标题“application / json内容类型:＼
--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”＼
——数据{“名称”:“热修复补丁/ needed-yesterday”}”

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“分支”:{“branch_id”：995991，“名称”：“热修复补丁/ needed-yesterday”，“created_at”：“2019-10-03 14:15:50(等/ UTC)”，“created_at_timestamp”：1567001750，“created_by”：1123，“created_by_email”："john@lokalise.com"}}

删除分支

删除项目中已配置的分支。需要管理员权限。

定义

         删去
         https://api.lokalise.com/api2/projects/{project_id}/部门/{branch_id}
        

示例请求

curl——request DELETE \
——https url:/ / api.lokalise.com/api2/projects/ {project_id} /分支/ {branch_id}

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“branch_deleted”：符合事实的｝

合并一个分支

合并项目中的一个分支。需要管理。

属性

强制\u冲突\u解决\u使用

字符串

指定如何解决冲突。可能的值是目标或源．
target_branch_id

数字

要合并到的分支。如果没有指定，默认为主分支。

定义

         帖子
         https://api.lokalise.com/api2/projects/{project_id}/部门/{branch_id}/合并
        

示例请求体

｛“force_conflict_resolve_using”：“目标”｝

示例请求

curl——请求发布\
——https url:/ / api.lokalise.com/api2/projects/ {project_id} / {branch_id} /合并\ /分支--标题“application / json内容类型:＼
--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”＼
——数据”{“force_conflict_resolve_using”:“目标”}’

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“branch_merged”：符合事实的，“分支”:{“branch_id”：995991，“名称”：“热修复补丁/ needed-yesterday”，“created_at”：“2019-10-03 14:15:50(等/ UTC)”，“created_at_timestamp”：1567001750，“created_by”：1123，“created_by_email”："john@lokalise.com"},“target_branch”:{“branch_id”：995123，“名称”：“掌握”，“created_at”：“2019-10-03 14:15:50(等/ UTC)”，“created_at_timestamp”：1567001750，“created_by”：1123，“created_by_email”："john@lokalise.com"}}

注释可以用来给译者提供一个关于密钥的上下文，或者作为对密钥翻译的某些方面的讨论。每个键都有一个单独的注释线程。所有的评论都交叉张贴到项目聊天。

注释对象

属性

comment_id

数字

注释的唯一标识符。
密钥id

数字

注释附加到的键的标识符。
评论

字符串

的评论。
添加了_by.

数字

留下评论的用户的标识符。
added_by_email

字符串

留下评论的用户的电子邮件。
添加了_T.

字符串

添加评论的日期和时间。
added_at_timestamp

数字

UNIX时间戳添加了评论。

列表项目的评论

检索项目中所有评论的列表。

Url参数

限制

字符串

默认值：100

要包括的项目数量(最多5000)。
页面

字符串

默认值：1

返回从该页开始的结果。

定义

         得到
         https://api.lokalise.com/api2/projects/{project_id:分支}/注释
        

示例请求

curl——request GET \
-  url.'https://api.lokalise.com/api2/projects/{project_id:branch}/comments？limit={limit}&page={page}'＼
--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

标题

X-Total-Count: 2

身体

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“评论”: [{“comment_id”：44444，“key_id”：12345，“评论”：“你好,世界!”，“added_by”：420.，“added_by_email”：“compounter@mycompany.com”，“添加在”：“2018-12-31 12:00:00(等\ / UTC)”，“added_at_timestamp”：1546257600}，{“comment_id”：44445，“key_id”：12346，“评论”：“再见,世界!”，“added_by”：420.，“added_by_email”：“compounter@mycompany.com”，“添加在”：“2018-12-31 12:00:00(等\ / UTC)”，“added_at_timestamp”：1546257600}]}

关键的评论列表

检索键的所有注释列表。

Url参数

限制

字符串

默认值：100

要包括的项目数量(最多5000)。
页面

字符串

默认值：1

返回从该页开始的结果。

定义

         得到
         https://api.lokalise.com/api2/projects/{project_id:分支}/键/{key_id}/注释
        

示例请求

curl——request GET \
-  url.“https://api.lokalise.com/api2/projects/ {project_id:分支}/键/ {key_id} /评论?限制={极限}和页面={页面}'＼
--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

标题

X-Total-Count: 2

身体

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“评论”: [{“comment_id”：44444，“key_id”：12345，“评论”：“你好,世界!”，“added_by”：420.，“added_by_email”：“compounter@mycompany.com”，“添加在”：“2018-12-31 12:00:00(等\ / UTC)”，“added_at_timestamp”：1546257600}，{“comment_id”：44445，“key_id”：12345，“评论”：“再见,世界!”，“added_by”：420.，“added_by_email”：“compounter@mycompany.com”，“添加在”：“2018-12-31 12:00:00(等\ / UTC)”，“added_at_timestamp”：1546257600}]}

创建的评论

向键添加一组注释。

属性

评论

字符串要求

要添加的评论。

定义

         帖子
         https://api.lokalise.com/api2/projects/{project_id:分支}/键/{key_id}/注释
        

示例请求体

｛“评论”: [{“评论”：“这是一次测试。”}，{“评论”：“添加多个注释。”}]}

示例请求

curl——请求发布\
——https url://api.lokalise.com/api2/projects/{project\u id:branch}/keys/{key\u id}/comments\--标题“application / json内容类型:＼
--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”＼
——数据'{"comments":[{"comment":"This is a test."},{“评论”:“添加多个注释。”}]}”

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“评论”: [{“comment_id”：44444，“key_id”：12345，“评论”：“这是一次测试。”，“added_by”：420.，“added_by_email”：“compounter@mycompany.com”，“添加在”：“2018-12-31 12:00:00(等\ / UTC)”，“added_at_timestamp”：1546257600}，{“comment_id”：44445，“key_id”：12345，“评论”：“添加多个注释。”，“added_by”：420.，“added_by_email”：“compounter@mycompany.com”，“添加在”：“2018-12-31 12:00:00(等\ / UTC)”，“added_at_timestamp”：1546257600}]}

检索一个评论

检索评论对象。

定义

         得到
         https://api.lokalise.com/api2/projects/{project_id:分支}/键/{key_id}/评论/{comment_id}
        

示例请求

curl——request GET \
——https url:/ / api.lokalise.com/api2/projects/ {project_id:分支}/键/ {key_id} / {comment_id} \ /评论--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“评论”:{“comment_id”：44444，“key_id”：12345，“评论”：“这是一次测试。”，“added_by”：420.，“added_by_email”：“compounter@mycompany.com”，“添加在”：“2018-12-31 12:00:00(等\ / UTC)”，“added_at_timestamp”：1546257600}}

删除评论

从项目中删除注释。经过身份验证的用户只能删除自己的注释。

定义

         删去
         https://api.lokalise.com/api2/projects/{project_id:分支}/键/{key_id}/评论/{comment_id}
        

示例请求

curl——request DELETE \
——https url:/ / api.lokalise.com/api2/projects/ {project_id:分支}/键/ {key_id} / {comment_id} \ /评论--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“comment_deleted”：符合事实的}

贡献者

您可以为您的项目添加无限数量的贡献者。用户角色包括管理员、翻译和审稿人。了解更多．

来源对象

属性

用户身份

数字

用户的唯一标识符。
电子邮件

字符串

与此用户关联的电子邮件。
fullname

字符串

用户设置的全名。
created_at.

字符串

创建用户的日期/时间。
created_at_timestamp

数字

创建用户时的Unix时间戳。
is_admin

布尔

用户是否对项目具有Admin权限。
是你的审稿人吗

布尔

用户是否拥有项目的审阅权限。
语言

对象

用户可访问的语言列表。
扩展属性密切属性
- lang_id
  
  数字
  
  语言ID。
- lang_iso
  
  字符串
  
  语言代码。
- 郎姓
  
  字符串
  
  语言的名字。
- is_writable
  
  布尔
  
  用户是否对该语言有写访问权限。
admin_rights

数组

用户权限列表。

列出所有的贡献者

列出项目的贡献者，包括对项目语言的访问级别。管理员对所有语言都有读/写权限。

Url参数

限制

字符串

默认值：100

要包括的项目数量(最多5000)。
页面

字符串

默认值：1

返回从该页开始的结果。

定义

         得到
         https://api.lokalise.com/api2/projects/{project_id:分支}/贡献者
        

示例请求

curl——request GET \
-  url.“https://api.lokalise.com/api2/projects/ {project_id:分支}/贡献者?限制={极限}和页面={页面}'＼
--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

标题

X-Total-Count：100

身体

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“贡献者”: [{“user_id”：420.，“电子邮件”：“Johndoe@mycompany.com”，“全名”：“John Doe”，“created_at”：“2018-01-01 12:00:00（etc \ / utc）”，“created_at_timestamp”：1546257600，“is_admin”：符合事实的，“is_reviewer”：符合事实的，“语言”: [{“语言id”：640，“lang_iso”：“en”，“lang_name”：“英语”，“is_writable”：1}，{“语言id”：597，“lang_iso”：“汝”，“lang_name”：“俄罗斯”，“is_writable”：1} ],“admin_rights”:【“钥匙”，“语言”[}]}

创建贡献者

在项目中创建一个或多个贡献者。需要管理贡献者管理权利。

如果is_admin标志设置为符合事实的，用户将自动访问所有项目语言，覆盖提供语言对象。属性fullname如果用户已经在Lokalise中注册，则将被忽略。

属性

电子邮件

字符串要求

电子邮件。
fullname

字符串

全名(仅对邀请用户有效，之前没有Lokalise账户的用户)。
is_admin

布尔

用户是否对项目具有Admin权限。
是你的审稿人吗

布尔

用户是否具有对项目的审阅权限。
语言

对象要求

用户可访问的语言列表。如果需要is_admin被设置为假．
扩展属性密切属性
- lang_iso
  
  字符串要求
  
  语言代码。
- is_writable
  
  布尔
  
  用户是否对该语言有写访问权限。
admin_rights

数组

自定义用户权限列表。可能的值是上传，活动，下载，设置，create_branches.，统计数据，键，截图，术语表，贡献者，语言，任务．省略或空参数将为用户角色设置默认的admin权限。

定义

         帖子
         https://api.lokalise.com/api2/projects/{project_id:分支}/贡献者
        

示例请求体

｛“贡献者”: [{“电子邮件”：“translator@mycompany.com”，“全名”：“翻译”先生，“is_admin”：假，“is_reviewer”：符合事实的，“语言”: [{“lang_iso”：“en”，“is_writable”：假}，{“lang_iso”：“汝”，“is_writable”：符合事实的}]}}

示例请求

curl——请求发布\
——https url:/ / api.lokalise.com/api2/projects/ {project_id:分支}/贡献者\--标题“application / json内容类型:＼
--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”＼
——数据{“贡献者”:[{“电子邮件”:“translator@mycompany.com”、“fullname”:“先生。翻译”、“is_admin”:假的,“is_reviewer”:真的,“语言”:[{“lang_iso”:“en”,“is_writable”:假},{“lang_iso”:“俄罗斯”,“is_writable”:真正}]}]}”

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“贡献者”:{“user_id”：421.，“电子邮件”：“translator@mycompany.com”，“全名”：“翻译”先生，“is_admin”：假，“is_reviwer”：符合事实的，“语言”: [{“lang_iso”：“en”，“is_writable”：假}，{“lang_iso”：“汝”，“is_writable”：符合事实的} ],“admin_rights”: []}}

检索一个贡献者

检索贡献者对象。

定义

         得到
         https://api.lokalise.com/api2/projects/{project_id:分支}/贡献者{contributor_id}
        

示例请求

curl——request GET \
——https url:/ / api.lokalise.com/api2/projects/ {project_id:分支}/ {contributor_id} \贡献者--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“贡献者”:{“user_id”：421.，“电子邮件”：“translator@mycompany.com”，“全名”：“翻译”先生，“is_admin”：假，“is_reviwer”：符合事实的，“语言”: [{“lang_iso”：“en”，“is_writable”：假}，{“lang_iso”：“汝”，“is_writable”：符合事实的} ],“admin_rights”:【“钥匙”，“语言”]}}

更新投稿人

更新贡献者的属性。需要管理贡献者管理权利。

如果您想让一个现有的贡献者访问一种新的语言，您必须指定full语言数组，包括先前添加的语言也是如此。

属性

is_admin

布尔

用户是否对项目具有Admin权限。
是你的审稿人吗

布尔

用户是否具有对项目的审阅权限。
语言

对象

用户可访问的语言列表。
扩展属性密切属性
- lang_iso
  
  字符串
  
  语言代码。
- is_writable
  
  布尔
  
  用户是否对该语言有写访问权限。
admin_rights

数组

自定义用户权限列表。可能的值是上传，活动，下载，设置，create_branches.，统计数据，键，截图，术语表，贡献者，语言，任务．空参数将为用户角色设置默认的管理权限。

定义

         把
         https://api.lokalise.com/api2/projects/{project_id:分支}/贡献者{contributor_id}
        

示例请求体

｛“is_admin”：符合事实的｝

示例请求

curl——request PUT \
——https url:/ / api.lokalise.com/api2/projects/ {project_id:分支}/ {contributor_id} \贡献者--标题“application / json内容类型:＼
--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”＼
——数据“{“is_admin”:真}”

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“贡献者”:{“user_id”：421.，“电子邮件”：“translator@mycompany.com”，“全名”：“翻译”先生，“is_admin”：符合事实的，“is_reviwer”：符合事实的，“语言”: [{“lang_iso”：“en”，“is_writable”：符合事实的}，{“lang_iso”：“汝”，“is_writable”：符合事实的} ],“admin_rights”:【“钥匙”，“语言”]}}

删除贡献者

从项目中删除用户。需要管理贡献者管理权利。

定义

         删去
         https://api.lokalise.com/api2/projects/{project_id:分支}/贡献者{contributor_id}
        

示例请求

curl——request DELETE \
——https url:/ / api.lokalise.com/api2/projects/ {project_id:分支}/ {contributor_id} \贡献者--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“contributor_deleted”：符合事实的｝

文件夹

本地化是面向项目的翻译管理系统，这意味着我们将所有的密钥和翻译存储在数据库中，并可以生成您需要的任何格式的文件。为一个或多个平台分配一个密钥意味着将该密钥包含在与该平台相关的文件格式的导出例程中，例如，如果一个密钥被分配给iOS平台，它将被包含在其中字符串和xliff格式出口。除了为平台分配密钥之外，您还可以为文件分配密钥，并根据平台使用不同的文件名。

最受欢迎的iOS，Android和Web语言文件格式支持。

文件对象

属性

文件名

字符串

文件名。
key_count

数字

与此文件相关联的键的总数。

列出所有文件

列出项目文件和相关的键数。如果项目中有一些键没有文件关联，它们将用文件名返回__unassigned__．

Url参数

filter_filename

字符串

为列表设置文件名筛选器。
限制

字符串

默认值：100

要包括的项目数量(最多5000)。
页面

字符串

默认值：1

返回从该页开始的结果。

定义

         得到
         https://api.lokalise.com/api2/projects/{project_id:分支}/文件
        

示例请求

curl——request GET \
-  url.'https://api.lokalise.com/api2/projects/{project\u id:branch}/files？filter\u filename={filter\u filename}&limit={limit}&page={page}'＼
--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“文件”: [{“文件名”：“index.json”，“key_count”：441.}，{“文件名”：“admin.json”，“key_count”：32}，{“文件名”：“__unassigned__”，“key_count”：11}]}

上传一个文件

队列用于导入的本地化文件并返回a202或302回应以及一个排队过程对象。了解更多．需要上传文件管理权利。支持的文件类型．

请注意302目前没有使用响应代码，但如果相同的文件已经在上传队列中，那么将来将返回响应代码。

属性

数据

字符串要求

Base64编码的文件。必须是支持的文件类型之一。
文件名

字符串要求

设置文件名。你可以选择在文件名中使用相对路径(例如admin/main.json)，但是要记住路径将成为文件的唯一部分。
lang_iso

字符串要求

正在导入的文件中翻译的语言代码。
convert_placeholders

布尔

默认值:真正的

允许自动将占位符转换为本地化通用占位符。
检测\u icu\u复数

布尔

能够自动检测和解析翻译中的ICU格式的复数。
标签

数组

带有指定标记的标记键。默认情况下，标记应用于创建和更新的键。
tag_inserted_keys

布尔

默认值:真正的

为插入的键添加指定的标记。
tag_updated_keys

布尔

默认值:真正的

将指定的标记添加到更新的密钥。
tag_skipped_keys

布尔

为跳过的键添加指定的标记。
replace_modified

布尔

启用以替换已修改的翻译（在正在上载的文件中）。
slashn_to_linebreak

布尔

允许用换行符替换\n。
keys_to_values

布尔

允许自动用键名替换值。
ictign_by_file.

布尔

启用以允许具有相似名称的密钥共存，以防他们分配给不同的文件名。
apply_tm

布尔

启用可自动应用100％翻译记忆库匹配。此选项将优先考虑use_automations如果设置为符合事实的．
use_automations

布尔

默认值:真正的

是否为该上载运行自动化。
hidden_from_contributors

布尔

自动设置新创建的密钥为“隐藏贡献者”。
cleanup_mode

布尔

启用以删除上载文件中不存在的所有语言翻译的所有密钥。您可能希望在导入新文件之前创建项目的快照，以防万一。
custom_translation_status_ids

数组

要添加到翻译中的自定义翻译状态id。默认情况下，状态应用于创建和更新的翻译。
custom_translation_status_inserted_keys

布尔

默认值:真正的

为插入键添加指定的自定义翻译状态。
自定义\翻译\状态\更新\密钥

布尔

默认值:真正的

向更新的键添加指定的自定义翻译状态。
自定义\u翻译\u状态\u跳过\u键

布尔

向跳过的键添加指定的自定义翻译状态。
skip_detect_lang_iso

布尔

跳过自动语言检测的文件名

定义

         帖子
         https://api.lokalise.com/api2/projects/{project_id:分支}/文件/上传
        

示例请求体

｛“文件名”：“index.json”，“数据”：“d94bwwgdmvyc2lvbj0ims4wiiblbmnvzgluzz0ivvrgl .....”，“lang_iso”：“en”，“标签”:【“指数”，“admin”，“版本”]，“转换\u占位符”：符合事实的｝

示例请求

curl——请求发布\
——https url://api.lokalise.com/api2/projects/{project_id:branch}/files/upload\--标题“application / json内容类型:＼
--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”＼
——数据'{“filename”：“index.json”，“数据”：“d94bwwgdmvyc2lvbj0ims4wiiblbmnvzgluzz0ivvrgl .....”，“lang_iso”：“en”，“标签”：[“索引”，“admin”，“v2.0“]，”convert_placeholders“：true}'

示例响应(202)

标题

         当前位置：/摄影：/摄影：/proplojects/767946315C1d0.08299127/processes/2e0559e60e8565555fbc15bdf78ab2b0ca3406e8f

身体

｛“项目id”：“767946315 e9866d013c1d0.08299127”，“过程”:{“process_id”：“2 e0559e60e856555fbc15bdf78ab2b0ca3406e8f”，“类型”：“文件导入”，“地位”：“排队”，“消息”：＂＂，“created_by”：1234，“created_by_email”：“example@example.com”，“created_at”：“2020-04-20 13:43:43（Etc/UTC）”，“created_at_timestamp”：1587390223}}

示例响应(302)

标题

         当前位置：/摄影：/摄影：/proplojects/767946315C1d0.08299127/processes/2e0559e60e8565555fbc15bdf78ab2b0ca3406e8f

身体

｛“项目id”：“767946315 e9866d013c1d0.08299127”，“过程”:{“process_id”：“2 e0559e60e856555fbc15bdf78ab2b0ca3406e8f”，“类型”：“文件导入”，“地位”：“排队”，“消息”：＂＂，“created_by”：1234，“created_by_email”：“example@example.com”，“created_at”：“2020-04-20 13:43:43（Etc/UTC）”，“created_at_timestamp”：1587390223}}

下载文件

以.zip包的形式导出项目文件。生成的bundle将被上传到Amazon S3 bucket中，该bucket将存储在那里12个月，可供下载。当bundle生成并上传时，您将得到一个带有文件URL的响应。需要下载文件管理权利。

在导出时，有两种方法可以根据文件名对键进行分组——一种是每种语言的所有键到单个文件中，另一种是使用前面分配的文件名。了解更多．

属性

格式

字符串要求

文件格式(例如json，字符串，xml)。必须是我们支持的任何文件格式的文件扩展名。也可能是ios_sdk或android_sdk对于各自的OTA SDK包。
原始文件名

布尔

允许使用原始文件名/格式。如果设置为假所有密钥将导出到每种语言的单个文件中。
bundle_structure

字符串

束结构，用于原始文件名设置为假．允许的占位符% LANG_ISO %，%郎_姓名%，%格式%和% PROJECT_NAME %）.
目录前缀

字符串

包中的目录前缀，当使用时原始文件名设置为符合事实的）.允许占位符% LANG_ISO %．
all_platforms.

布尔

允许包含所有平台键。如果禁用，则只有密钥，与平台相关联的格式将被导出。
filter_langs

数组

要导出的语言列表。对于所有语言，忽略此参数。
filter_data

数组

导出数据范围小。允许的值是翻译或未经翻译，综述了(或仅审查)，last_reviewed_only，验证和non．
filter_filenames

数组

只包括归属于选定文件的键。空留给所有人。
add_newline_eof

布尔

允许在文件末尾添加新行(如果格式支持)。
custom_translation_status_ids

数组

只包括归因于选定的自定义状态的翻译。空留给所有人。
include_tags

数组

指定标签的窄导出范围。
exclude_tags

数组

指定使用这些标记排除键。
export_sort

字符串

导出键排序模式。允许的值first_added，last_added.，last_updated，a_z，佐亚．
export_empty_as

字符串

默认值:空

选择您希望以何种方式导出空翻译。允许的值是空保持空的,基地若要用基本语言值替换，无效的将其替换为null(仅限YAML导出)，或者跳过省略。
export_null_as

字符串

默认值:空

(仅限Ruby on Rails YAML导出)选择您希望如何导出null (void)翻译。允许的值是无效的保持空,空替换为空字符串。
包括您的评论

布尔

允许在导出文件中包含关键注释和描述(如果格式支持)。
include_description

布尔

允许在导出文件中包含关键描述(如果格式支持)。
include_pids

数组

其他项目ID，这些键应该包含在此导出中。
触发器

数组

触发集成导出(必须在项目设置中启用)。允许的值是amazons3，地面军事系统，github，github企业，gitlab，bitbucket都，比特桶企业，azure．
filter_repositories

数组

拉取请求将仅为列出的存储库创建(组织/存储库格式)。保留空数组，仅按平台处理所有配置的集成。
replace_breaks

布尔

默认值:真正的

通过\ n替换导出的翻译中的行中断。
disable_references

布尔

启用以跳过自动更换关键参考占位符（例如[％key：hello_world％]），其中包含相应的翻译。
plural_format

字符串

覆盖文件类型的默认复数格式。允许的值是json_string，加护病房，数组，通用的，symfony，i18next．有关对特定文件格式的复数支持的更多信息，请参阅复数和占位符。
placeholder_format

字符串

覆盖文件类型的默认占位符格式。允许的值是printf，ios，加护病房，网，symfony）.有关更多信息，请参阅复数和占位符。
webhook_url

字符串

导出完成后，将带有生成的bundle URL的HTTP POST发送到指定的URL。
语言映射

对象

用于覆盖此导出的默认iso代码的语言列表。
扩展属性密切属性
- original_language_iso
  
  字符串
  
  在语言设置中定义的原始语言代码。
- custom_language_iso
  
  字符串
  
  语言代码来替换原始代码。
icu_numeric

布尔

如果可以，复数形式零，一和两个将被替换= 0，= 1和= 2分别。仅适用于ICU复数格式。
escape_percent

布尔

仅适用于Printf占位符格式。启用后，所有通用百分比占位符“[％]”将始终导出为“%%”。
缩进

字符串

默认值:默认

提供以覆盖受支持文件中的默认缩进。允许的值为默认的，1sp，2 sp，3 sp，4 sp，5 sp，6SP.，7 sp，8 sp和选项卡．
yaml_include_root

布尔

(仅YAML出口)。允许包含语言ISO代码作为根键。
json_unescaped_slashes

布尔

（仅限JSON导出）。启用向前斜线未向前斜线。
java_properties_encoding

字符串

默认值:latin - 1

（仅限Java属性导出）。为.properties文件编码。允许的值为UTF-8.和latin - 1．
java_properties_separator.

字符串

默认值：：

(Java属性导出)。分隔符用于.properties文件中的键/值。允许的值是＝和：．
bundle_description

字符串

创建的bundle的描述。适用于ios_sdk或android_sdkOTA SDK包。

定义

         帖子
         https://api.lokalise.com/api2/projects/{project_id:分支}/ /下载文件
        

示例请求体

｛“格式”：“json”，“original_filenames”：符合事实的｝

示例请求

curl——请求发布\
——https url:/ / api.lokalise.com/api2/projects/ {project_id:分支}/文件/下载\--标题“application / json内容类型:＼
--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”＼
——数据'{“格式”：“JSON”，“Oricall_FiLenames”：True}'

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“bundle_url”：“https: \ / \ / s3 -欧盟-西方- 1. - amazonaws.com \ / lokalise-assets \ /导出\ / MyApp-locale.zip”｝

键

关键字是项目的核心元素。

在你的应用程序或网站中使用的每个短语都必须通过一个键来识别，并具有代表不同语言翻译的值。例如关键index.welcome的值欢迎英语和Benvenuto在意大利。密钥可以分配给一个或多个平台。一旦一个键被分配给一个平台，它将被包含在与这个平台相关的文件格式的导出中。

Lokalise的一个独特功能是能够在不同平台上使用类似的键，从而减少翻译人员的翻译工作量。一旦你导入或添加键，它们需要被分配到一个或多个平台(例如iOS, Android)。了解更多．

关键对象

属性

密钥id

数字

密钥的唯一标识符。
created_at.

字符串

密钥的创建日期。
created_at_timestamp

数字

创建密钥时的Unix时间戳。
关键字名称

对象

包含所有平台的键名的对象。您可能需要在项目设置中启用“每个平台的键名”，以便分别更改每个平台的键名。注意，当创建/更新键时，根据你的项目设置(每个平台的键名)，你可能需要传递一个字符串(如果设置是禁用的)或一个对象(如果设置是启用的)。
扩展属性密切属性
- ios
  
  字符串
  
  “iOS”平台密钥名称。
- 安卓
  
  字符串
  
  “Android”平台密钥名称。
- 网页
  
  字符串
  
  “Web”平台密钥名称。
- 其他
  
  字符串
  
  “其他”平台密钥名称。
文件名

对象

一个包含每个平台的键文件名属性的对象。
扩展属性密切属性
- ios
  
  字符串
  
  “iOS”平台文件名。
- 安卓
  
  字符串
  
  “Android”平台文件名。
- 网页
  
  字符串
  
  “Web”平台文件名。
- 其他
  
  字符串
  
  “其他”平台文件名。
描述

字符串

密钥的描述信息。
平台

数组

此密钥已启用的平台列表。
标签

数组

此键的标记列表。
评论

对象

此键的注释。
扩展属性密切属性
- comment_id
  
  数字
  
  注释的唯一标识符。
- 评论
  
  字符串
  
  的评论。
- 添加了_by.
  
  数字
  
  留下评论的用户的唯一标识符。
- added_by_email
  
  字符串
  
  留下评论的用户的电子邮件。
- 添加了_T.
  
  字符串
  
  添加评论的日期。
- added_at_timestamp
  
  数字
  
  添加注释时的Unix时间戳。
截图

对象

截图，附于此键。
扩展属性密切属性
- screenshot_id
  
  数字
  
  屏幕截图的唯一标识符。
- key_ids
  
  数组
  
  键标识符列表，截屏附加到。
- 网址
  
  字符串
  
  链接到屏幕截图。
- 标题
  
  字符串
  
  截图标题。
- 描述
  
  字符串
  
  对截图的描述。
- screenshot_tags
  
  数组
  
  截图标签列表。
- 宽度
  
  数字
  
  屏幕截图的宽度，以像素为单位。
- 身高
  
  数字
  
  截屏的高度，以像素为单位。
- created_at.
  
  字符串
  
  创建日期的截图。
- created_at_timestamp
  
  数字
  
  创建截图时的Unix时间戳。
翻译

对象

所有语言的翻译。
扩展属性密切属性
- translation_id
  
  数字
  
  翻译条目的唯一标识符。
- 密钥id
  
  数字
  
  密钥的唯一标识符。
- language_iso
  
  字符串
  
  独特的代码语言的翻译。
- 翻译
  
  字符串
  
  实际的翻译。Pass作为一个对象，以防它包含复数形式和is_plural是符合事实的．
- 修改
  
  数字
  
  已更新翻译的用户的标识符。
- modified_by_email
  
  字符串
  
  已更新翻译的用户的电子邮件。
- 修改的
  
  字符串
  
  最后修改译文的日期。
- modified_at_timestamp.
  
  数字
  
  unix时间戳最后修改翻译。
- 你被审查了吗
  
  布尔
  
  翻译是否标记为已审核。
- is_unverified
  
  布尔
  
  翻译是否被标记为未验证。
- reviewed_by
  
  数字
  
  已审阅过翻译的用户标识符(如果审阅过)。
- 单词
  
  数字
  
  翻译的字数。
- 自定义\u翻译\u状态
  
  数组
  
  组成的数组自定义翻译状态对象。
- 任务id
  
  数字
  
  任务的标识符，如果密钥是一个的一部分，或无效的如果不是。
is_plural

布尔

这个关键是复数。
plural_name

字符串

可选自定义复数名称(在某些格式中使用)。
is_hidden.

布尔

是否对非管理员(翻译人员)隐藏此密钥。
is_archived

布尔

是否存档此密钥。
上下文

字符串

键的可选上下文(用于某些文件格式)。
base_words

数字

基本语言中的单词数。
字符数极限

数字

此密钥翻译中允许的最大字符数。
custom_attributes.

数组

json包含自定义属性(如果有的话)。
修改的

字符串

最新关键更新的日期（包括屏幕截图和评论）。
modified_at_timestamp.

数字

最新密钥更新的Unix时间戳(包括屏幕截图和注释)。
translations_modified_at

字符串

最新的密钥翻译更新日期。
translations_modified_at_timestamp.

数字

最新密钥转换更新的Unix时间戳。

列出所有密钥

列出项目中的所有键。重要的是:我们不为您的语言文件提供内容交付网络。不要向你的网站/应用程序的每个访问者提出这个端点的请求。相反，要不时地获取这个端点，将结果存储在本地，并为您的访问者提供静态文件/数据库内容。或者，您可以使用我们的Amazon S3/谷歌CouldStorage集成自动上传您的语言文件到您选择的桶。

Url参数

disable_references

字符串

默认值：0

是否禁用键引用。可能的值是1和0．
包括您的评论

字符串

默认值：0

是否包括评论。可能的值是1和0．
include_screenshots

字符串

默认值：0

是否包含屏幕截图的URL。可能的值是1和0．
include_translations

字符串

默认值：0

是否包括翻译。可能的值是1和0．
filter_translation_lang_ids

字符串

一个或多个要过滤的语言ID(用逗号分隔)。将只包括列出的id的翻译。
过滤标签

字符串

一个或多个要过滤的标记(用逗号分隔)。
filter_filenames

字符串

一个或多个要过滤的文件名(用逗号分隔)。
filter_keys

字符串

要筛选的一个或多个键名（逗号分隔）。如果在项目设置中启用了“每个平台密钥”，则过滤器将应用于所有平台名称。
filter_key_ids.

字符串

要筛选的一个或多个键标识符（逗号分隔）。
filter_platform.

字符串

要筛选的一个或多个平台（逗号分隔）。可能的值是ios，安卓，网页和其他．
filter_untranslated

字符串

默认值：0

通过未翻译的键进行过滤。可能的值是1和0．
filter_qa_issues

字符串

一个或多个QA问题要过滤(逗号分隔)。可能的值是spelling_and_grammar，占位符，超文本标记语言，url_count，网址，Email_Count.，电子邮件，括号，数字，leading_whitespace，trailing_whitespace，double_space，Special_PlaceHolder.和Unbalanced_Brackets.．
filter_archived

字符串

默认值:包括

一个存档过滤器。可能的值是包括，排除和只有．
限制

字符串

默认值：100

要包括的项目数量(最多5000)。
页面

字符串

默认值：1

返回从该页开始的结果。

定义

         得到
         https://api.lokalise.com/api2/projects/{project_id:分支}/键
        

示例请求

curl——request GET \
-  url.'https://api.lokalise.com/api2/projects/{project_id:branch}/keys？include_translations={include_translations}&include_comments={include_comments}&include_screenshots={include_screenshots}&limit={limit}&page={page}＼
--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

标题

X-Total-Count: 538

身体

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“钥匙”: [{“key_id”：222222，“created_at”：“2018-12-31 12:00:00(等\ / UTC)”，“created_at_timestamp”：1546257600，“key_name”:{“苹果”：“欢迎光临”，“android”：“indexWelcome”，“网络”：“索引，欢迎”，“其他”：“welcome-index”},“文件名”:{“苹果”：＂＂，“android”：＂＂，“网络”：＂＂，“其他”：＂＂},“描述”：“索引页欢迎”，“平台”:【“苹果”，“android”，“网络”，“其他”]，“标签”:【“主要”，“指数”]，“评论”: [{“comment_id”：233112，“评论”：“有感叹号吗？”，“added_by”：420.，“added_by_email”：“user@mycompany.com”，“添加在”：“2018-12-31 12:00:00(等\ / UTC)”，“added_at_timestamp”：1546257600} ],“截图”: [{“screenshot_id”：11233，“标题”：“欢迎页面”，“描述”：＂＂，“screenshot_tags”:【“指数”]，“url”：“https://s3 -欧盟-西方- 1. - amazonaws.com/files/screenshots/welcome.jpg”，“created_at”：“2019-02-01 12:00:00(等\ / UTC)”，“created_at_timestamp”：1546257600} ],“翻译”: [{“translation_id”：444212，“key_id”：222222，“language_iso”：“en”，“翻译”：“欢迎来到MyApp !”，“modified_by”：420.，“modified_by_email”：“user@mycompany.com”，“modified_at”：“2018-12-31 12:00:00(等\ / UTC)”，“modified_at_timestamp”：1546257600，“是否已审核”：符合事实的，“reviewed_by”：1357，“文字”：3.，“custom_translation_statuses”:[],“任务id”：2185.}，{“translation_id”：444147，“key_id”：222222，“language_iso”：“汝”，“翻译”：“Добропожаловать!”，“modified_by”：422.，“modified_by_email”：“translator@mycompany.com”，“modified_at”：“2018-12-31 12:00:00(等\ / UTC)”，“modified_at_timestamp”：1546257600，“是否已审核”：假，“reviewed_by”：0，“文字”：2，“custom_translation_statuses”:[],“任务id”：无效的}]}， ....]}

创建密钥

在项目中创建一个或多个密钥。需要管理密钥管理权。我们建议按每个请求最多500个密钥的块发送有效负载。

属性

键

对象

将添加到项目中的键
扩展属性密切属性
- 关键字名称
  
  字符串要求
  
  键标识符。对于启用了Per-platform键名的项目，传递包含的JSON编码字符串ios，安卓，网页和其他字符串属性。
- 描述
  
  字符串
  
  密钥的描述信息。
- 平台
  
  数组要求
  
  此密钥已启用的平台列表。可能的值是ios，安卓，网页和其他．
- 文件名
  
  对象
  
  一个包含每个平台的键文件名属性的对象。
  扩展属性密切属性
  - ios
    
    字符串
    
    “iOS”平台文件名。
  - 安卓
    
    字符串
    
    “Android”平台文件名。
  - 网页
    
    字符串
    
    “Web”平台文件名。
  - 其他
    
    字符串
    
    “其他”平台文件名。
- 标签
  
  数组
  
  此键的标记列表。
- 评论
  
  对象
  
  此密钥的注释列表。
  扩展属性密切属性
  - 评论
    
    字符串
    
    的评论。
- 截图
  
  对象
  
  截图列表，附于此键。
  扩展属性密切属性
  - 标题
    
    字符串
    
    截图的标题。
  - 描述
    
    字符串
    
    对截图的描述。
  - screenshot_tags
    
    数组
    
    截图标签列表。
  - 数据
    
    字符串
    
    Base64编码的截图(带有前导图像类型'data:image/jpeg; Base64，')。
- 翻译
  
  对象
  
  所有语言的翻译。
  扩展属性密切属性
  - language_iso
    
    字符串
    
    独特的代码语言的翻译。
  - 翻译
    
    字符串
    
    实际的翻译。Pass作为一个对象，以防它包含复数形式和is_plural是符合事实的．
  - 你被审查了吗
    
    布尔
    
    翻译是否标记为已审核。
  - is_unverified
    
    布尔
    
    翻译是否被标记为未验证。
  - custom_translation_status_ids
    
    数组
    
    要分配给翻译的自定义翻译状态id。
- is_plural
  
  布尔
  
  这个关键是复数。
- plural_name
  
  字符串
  
  可选自定义复数名称(在某些格式中使用)。
- is_hidden.
  
  布尔
  
  是否对非管理员(翻译人员)隐藏此密钥。
- is_archived
  
  布尔
  
  是否存档此密钥。
- 上下文
  
  字符串
  
  键的可选上下文(用于某些文件格式)。
- 字符数极限
  
  数字
  
  此密钥翻译中允许的最大字符数。
- custom_attributes.
  
  字符串
  
  JSON编码字符串包含自定义属性(如果有的话)。
use_automations

布尔

默认值:真正的

是否在新的键翻译上运行自动化。

定义

         帖子
         https://api.lokalise.com/api2/projects/{project_id:分支}/键
        

示例请求体

｛“钥匙”: [{“key_name”：“索引，欢迎”，“描述”：“欢迎使用索引应用程序”，“平台”:【“网络”]，“翻译”: [{“language_iso”：“en”，“翻译”：“欢迎”}]}，{“key_name”：“index.apple”，“描述”：“欢迎苹果”，“平台”:【“网络”]，“is_plural”：符合事实的，“翻译”: [{“language_iso”：“en”，“翻译”:{“一”：“我有一个苹果”，“其他”：“我有很多苹果”}}]}， {“key_name”：“index.hello”，“平台”:【“网络”[}]}

示例请求

curl——请求发布\
——https url:/ / api.lokalise.com/api2/projects/ \ {project_id:分支}/键--标题“application / json内容类型:＼
--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”＼
——数据{“钥匙”:[{“key_name”:“指数。欢迎”、“描述”:“指数应用欢迎”、“平台”:“网络”,“翻译”:[{“language_iso”:“en”,“翻译”:“欢迎”}]},{:“key_name指数。苹果苹果”、“描述”:“欢迎”、“平台”:“网络”,“is_plural”:的确,翻译:[{“language_iso”:“en”,“翻译”:{“一”:“我有一个苹果”,“其他”:“我有很多苹果“}}]},{“key_name”:“index.hello”、“平台”:(“网络”)}]}’

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“钥匙”: [{“key_id”：331223，“created_at”：“2018-12-31 12:00:00(等\ / UTC)”，“created_at_timestamp”：1546257600，“key_name”:{“苹果”：“索引，欢迎”，“android”：“索引，欢迎”，“网络”：“索引，欢迎”，“其他”：“索引，欢迎”},“文件名”:{“苹果”：＂＂，“android”：＂＂，“网络”：＂＂，“其他”：＂＂},“描述”：“欢迎使用索引应用程序”，“平台”:【“网络”]，“标签”:[],“评论”:[],“截图”:[],“翻译”: [{“translation_id”：444921，“key_id”：331223，“language_iso”：“en”，“翻译”：“欢迎”，“modified_by”：420.，“modified_by_email”：“user@mycompany.com”，“modified_at”：“2018-12-31 12:00:00(等\ / UTC)”，“modified_at_timestamp”：1546257600，“是否已审核”：假，“reviewed_by”：0，“文字”：0，“custom_translation_statuses”:[],“任务id”：492}，{“translation_id”：444929，“key_id”：331223，“language_iso”：“汝”，“翻译”：＂＂，“modified_by”：420.，“modified_by_email”：“user@mycompany.com”，“modified_at”：“2018-12-31 12:00:00(等\ / UTC)”，“modified_at_timestamp”：1546257600，“是否已审核”：假，“reviewed_by”：0，“文字”：0，“custom_translation_statuses”:[],“任务id”：无效的}]}，{“key_id”：331224，“created_at”：“2018-12-31 12:00:00(等\ / UTC)”，“created_at_timestamp”：1546257600，“key_name”:{“苹果”：“index.apple”，“android”：“index.apple”，“网络”：“index.apple”，“其他”：“index.apple”},“文件名”:{“苹果”：＂＂，“android”：＂＂，“网络”：＂＂，“其他”：＂＂},“描述”：“欢迎苹果”，“平台”:【“网络”]，“is_plural”：符合事实的，“标签”:[],“评论”:[],“截图”:[],“翻译”: [{“translation_id”：444941，“key_id”：331224，“language_iso”：“en”，“翻译”：“{\'one\'：\'我有一个苹果\'，\'其他\'：'我有很多苹果\'”，“modified_by”：420.，“modified_by_email”：“user@mycompany.com”，“modified_at”：“2018-12-31 12:00:00(等\ / UTC)”，“modified_at_timestamp”：1546257600，“是否已审核”：假，“reviewed_by”：0，“文字”：0，“custom_translation_statuses”:[],“任务id”：9147}，{“translation_id”：444949，“key_id”：331224，“language_iso”：“汝”，“翻译”：“{\” \":\"\",\" 几 \":\"\",\" 许多 \":\"\",\" 其他\ ":\ " \“}”，“modified_by”：420.，“modified_by_email”：“user@mycompany.com”，“modified_at”：“2018-12-31 12:00:00(等\ / UTC)”，“modified_at_timestamp”：1546257600，“是否已审核”：假，“reviewed_by”：0，“文字”：0，“custom_translation_statuses”:[],“任务id”：无效的} ] } ],“错误”: [{“消息”："此密钥名已被占用"，“代码”：400，“钥匙”:{“key_name”：“index.hello”}}]}

检索一个关键

检索钥匙对象。

Url参数

disable_references

字符串

默认值：0

是否禁用键引用。可能的值是1和0．

定义

         得到
         https://api.lokalise.com/api2/projects/{project_id:分支}/键/{key_id}
        

示例请求

curl——request GET \
——https url:/ / api.lokalise.com/api2/projects/ {project_id:分支}/键/ {key_id} \--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“钥匙”:{“key_id”：222222，“created_at”：“2018-12-31 12:00:00(等\ / UTC)”，“created_at_timestamp”：1546257600，“key_name”:{“苹果”：“欢迎光临”，“android”：“indexWelcome”，“网络”：“索引，欢迎”，“其他”：“welcome-index”},“文件名”:{“苹果”：＂＂，“android”：＂＂，“网络”：＂＂，“其他”：＂＂},“描述”：“索引页欢迎”，“平台”:【“网络”，“其他”]，“标签”:【“主要”，“指数”]，“评论”: [{“comment_id”：233112，“评论”：“有感叹号吗？”，“added_by”：420.，“added_by_email”：“user@mycompany.com”，“添加在”：“2018-12-31 12:00:00(等\ / UTC)”，“added_at_timestamp”：1546257600} ],“截图”: [{“screenshot_id”：11233，“标题”：“欢迎页面”，“描述”：＂＂，“screenshot_tags”:【“指数”]，“url”：“https://s3 -欧盟-西方- 1. - amazonaws.com/files/screenshots/welcome.jpg”，“created_at”：“2019-02-01 12:00:00(等\ / UTC)”，“created_at_timestamp”：1546257600} ],“翻译”: [{“translation_id”：444212，“key_id”：222222，“language_iso”：“en”，“翻译”：“欢迎来到MyApp !”，“modified_by”：420.，“modified_by_email”：“user@mycompany.com”，“modified_at”：“2018-12-31 12:00:00(等\ / UTC)”，“modified_at_timestamp”：1546257600，“是否已审核”：符合事实的，“reviewed_by”：1357，“文字”：3.，“custom_translation_statuses”:[],“任务id”：95}，{“translation_id”：444147，“key_id”：222222，“language_iso”：“汝”，“翻译”：“Добропожаловать!”，“modified_by”：422.，“modified_by_email”：“translator@mycompany.com”，“modified_at”：“2018-12-31 12:00:00(等\ / UTC)”，“modified_at_timestamp”：1546257600，“是否已审核”：假，“reviewed_by”：0，“文字”：2，“custom_translation_statuses”:[],“任务id”：无效的}]}}

更新一个关键

更新键及其关联对象的属性。需要管理密钥管理权利。

属性

关键字名称

字符串

键标识符。对于启用了Per-platform键名的项目，传递包含的JSON编码字符串ios，安卓，网页和其他字符串属性。
描述

字符串

密钥的描述信息。
平台

数组

此密钥已启用的平台列表。可能的值是ios，安卓，网页和其他．
文件名

对象

一个包含每个平台的键文件名属性的对象。
扩展属性密切属性
- ios
  
  字符串
  
  “iOS”平台文件名。
- 安卓
  
  字符串
  
  “Android”平台文件名。
- 网页
  
  字符串
  
  “Web”平台文件名。
- 其他
  
  字符串
  
  “其他”平台文件名。
标签

数组

此键的标记列表。
merge_tags

布尔

允许将指定的标记与附加到键上的当前标记合并。
is_plural

布尔

这个关键是复数。
plural_name

字符串

可选自定义复数名称(在某些格式中使用)。
is_hidden.

布尔

是否对非管理员(翻译人员)隐藏此密钥。
is_archived

布尔

是否存档此密钥。
上下文

字符串

键的可选上下文(用于某些文件格式)。
字符数极限

数字

此密钥翻译中允许的最大字符数。
custom_attributes.

字符串

JSON编码字符串包含自定义属性(如果有的话)。

定义

         把
         https://api.lokalise.com/api2/projects/{project_id:分支}/键/{key_id}
        

示例请求体

｛“平台”:【“网络”，“其他”]，“描述”：“欢迎使用索引应用程序”｝

示例请求

curl——request PUT \
——https url:/ / api.lokalise.com/api2/projects/ {project_id:分支}/键/ {key_id} \--标题“application / json内容类型:＼
--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”＼
——数据{“平台”:“网络”,“其他”,“描述”:“指数应用欢迎“}”

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“钥匙”:{“key_id”：331223，“created_at”：“2018-12-31 12:00:00(等\ / UTC)”，“created_at_timestamp”：1546257600，“key_name”:{“苹果”：“new.index.welcome”，“android”：“索引，欢迎”，“网络”：“索引，欢迎”，“其他”：“索引，欢迎”},“文件名”:{“苹果”：＂＂，“android”：＂＂，“网络”：＂＂，“其他”：＂＂},“描述”：“欢迎使用索引应用程序”，“平台”:【“网络”，“其他”]，“标签”:[],“评论”:[],“截图”:[],“翻译”: [{“translation_id”：444921，“key_id”：331223，“language_iso”：“en”，“翻译”：＂＂，“modified_by”：420.，“modified_by_email”：“user@mycompany.com”，“modified_at”：“2018-12-31 12:00:00(等\ / UTC)”，“modified_at_timestamp”：1546257600，“是否已审核”：假，“reviewed_by”：0，“文字”：0，“custom_translation_statuses”:[],“任务id”：121}，{“translation_id”：444929，“key_id”：331223，“language_iso”：“汝”，“翻译”：＂＂，“modified_by”：420.，“modified_by_email”：“user@mycompany.com”，“modified_at”：“2018-12-31 12:00:00(等\ / UTC)”，“modified_at_timestamp”：1546257600，“是否已审核”：假，“reviewed_by”：0，“文字”：0，“custom_translation_statuses”:[],“任务id”：无效的}]}}

批量更新

更新项目中的一个或多个密钥。需要管理密钥管理权利。

属性

键

对象

密钥更新
扩展属性密切属性
- 密钥id
  
  数字要求
  
  密钥的唯一标识符。
- 关键字名称
  
  字符串
  
  键标识符。对于启用了Per-platform键名的项目，传递包含的JSON编码字符串ios，安卓，网页和其他字符串属性。
- 描述
  
  字符串
  
  密钥的描述信息。
- 平台
  
  数组
  
  此密钥已启用的平台列表。可能的值是ios，安卓，网页和其他．
- 文件名
  
  对象
  
  一个包含每个平台的键文件名属性的对象。
  扩展属性密切属性
  - ios
    
    字符串
    
    “iOS”平台文件名。
  - 安卓
    
    字符串
    
    “Android”平台文件名。
  - 网页
    
    字符串
    
    “Web”平台文件名。
  - 其他
    
    字符串
    
    “其他”平台文件名。
- 标签
  
  数组
  
  此键的标记列表。
- merge_tags
  
  布尔
  
  允许将指定的标记与附加到键上的当前标记合并。
- 评论
  
  对象
  
  此密钥的注释列表。
  扩展属性密切属性
  - 评论
    
    字符串
    
    的评论。
- 截图
  
  对象
  
  截图列表，附于此键。
  扩展属性密切属性
  - 标题
    
    字符串
    
    截图的标题。
  - 描述
    
    字符串
    
    对截图的描述。
  - screenshot_tags
    
    数组
    
    截图标签列表。
  - 数据
    
    字符串
    
    Base64编码的截图(带有前导图像类型'data:image/jpeg; Base64，')。
- 翻译
  
  对象
  
  所有语言的翻译。
  扩展属性密切属性
  - language_iso
    
    字符串
    
    独特的代码语言的翻译。
  - 翻译
    
    字符串
    
    实际的翻译。Pass作为一个对象，以防它包含复数形式和is_plural是符合事实的．
  - 你被审查了吗
    
    布尔
    
    翻译是否标记为已审核。
  - is_unverified
    
    布尔
    
    翻译是否被标记为未验证。
  - custom_translation_status_ids
    
    数组
    
    将分配给转换的自定义转换状态ID（现有状态将被替换）。
  - merge_custom_translation_statuses
    
    布尔
    
    如果不希望状态被替换，而是使用provided合并，则将此设置为true。
- is_plural
  
  布尔
  
  这个关键是复数。
- plural_name
  
  字符串
  
  可选自定义复数名称(在某些格式中使用)。
- is_hidden.
  
  布尔
  
  是否对非管理员(翻译人员)隐藏此密钥。
- is_archived
  
  布尔
  
  是否存档此密钥。
- 上下文
  
  字符串
  
  键的可选上下文(用于某些文件格式)。
- 字符数极限
  
  数字
  
  此密钥翻译中允许的最大字符数。
- custom_attributes.
  
  字符串
  
  JSON编码字符串包含自定义属性(如果有的话)。
use_automations

布尔

默认值:真正的

是否对已更新的键翻译运行自动化。

定义

         把
         https://api.lokalise.com/api2/projects/{project_id:分支}/键
        

示例请求体

｛“钥匙”: [{“key_id”：331223，“key_name”：“索引，欢迎”，“描述”：“欢迎使用索引应用程序”，“平台”:【“网络”}, {“key_id”：331224，“key_name”：“index.hello”，“描述”：“指数的问候”，“平台”:【“网络”[}]}

示例请求

curl——request PUT \
——https url:/ / api.lokalise.com/api2/projects/ \ {project_id:分支}/键--标题“application / json内容类型:＼
--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”＼
——数据'{“键”：[{“key_id”：331223，“key_name”：“index.welcome”，“描述”：“索引应用程序欢迎”，“平台”：[“Web”]}，{“key_id”：331224，“key_name”：“index.hello”，“描述”：“索引问候”，“平台”：[“Web”]}]}'

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“钥匙”: [{“key_id”：331223，“created_at”：“2018-12-31 12:00:00(等\ / UTC)”，“created_at_timestamp”：1546257600，“key_name”:{“苹果”：“索引，欢迎”，“android”：“索引，欢迎”，“网络”：“索引，欢迎”，“其他”：“索引，欢迎”},“文件名”:{“苹果”：＂＂，“android”：＂＂，“网络”：＂＂，“其他”：＂＂},“描述”：“欢迎使用索引应用程序”，“平台”:【“网络”]，“标签”:[],“评论”:[],“截图”:[],“翻译”: [{“translation_id”：444921，“key_id”：331223，“language_iso”：“en”，“翻译”：＂＂，“modified_by”：420.，“modified_by_email”：“user@mycompany.com”，“modified_at”：“2018-12-31 12:00:00(等\ / UTC)”，“modified_at_timestamp”：1546257600，“是否已审核”：假，“reviewed_by”：0，“文字”：0，“custom_translation_statuses”:[],“任务id”：512}，{“translation_id”：444929，“key_id”：331223，“language_iso”：“汝”，“翻译”：＂＂，“modified_by”：420.，“modified_by_email”：“user@mycompany.com”，“modified_at”：“2018-12-31 12:00:00(等\ / UTC)”，“modified_at_timestamp”：1546257600，“是否已审核”：假，“reviewed_by”：0，“文字”：0，“custom_translation_statuses”:[],“任务id”：无效的}]}，{“key_id”：331224，“created_at”：“2018-12-31 12:00:00(等\ / UTC)”，“created_at_timestamp”：1546257600，“key_name”:{“苹果”：“索引，欢迎”，“android”：“索引，欢迎”，“网络”：“索引，欢迎”，“其他”：“索引，欢迎”},“文件名”:{“苹果”：＂＂，“android”：＂＂，“网络”：＂＂，“其他”：＂＂},“描述”：“欢迎使用索引应用程序”，“平台”:【“网络”]，“标签”:[],“评论”:[],“截图”:[],“翻译”: [{“translation_id”：444921，“key_id”：331223，“language_iso”：“en”，“翻译”：＂＂，“modified_by”：420.，“modified_by_email”：“user@mycompany.com”，“modified_at”：“2018-12-31 12:00:00(等\ / UTC)”，“modified_at_timestamp”：1546257600，“是否已审核”：假，“reviewed_by”：0，“文字”：0，“custom_translation_statuses”:[],“任务id”：906.}，{“translation_id”：444929，“key_id”：331223，“language_iso”：“汝”，“翻译”：＂＂，“modified_by”：420.，“modified_by_email”：“user@mycompany.com”，“modified_at”：“2018-12-31 12:00:00(等\ / UTC)”，“modified_at_timestamp”：1546257600，“是否已审核”：假，“reviewed_by”：0，“文字”：0，“custom_translation_statuses”:[],“任务id”：无效的} ] } ],“错误”: [ ] }

删除多个键

从项目中删除多个键。需要管理密钥管理权利。

属性

键

数组要求

键id列表。

定义

         删去
         https://api.lokalise.com/api2/projects/{project_id:分支}/键
        

示例请求体

｛“钥匙”:【12345，12346]}

示例请求

curl——request DELETE \
——https url:/ / api.lokalise.com/api2/projects/ \ {project_id:分支}/键--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”＼
——数据{“钥匙”:(12345、12346)}”

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“keys_removed”：符合事实的，“keys_locked”：0｝

删除一个关键

从项目中删除一个键。需要管理密钥管理权利。

定义

         删去
         https://api.lokalise.com/api2/projects/{project_id:分支}/键/{key_id}
        

示例请求

curl——request DELETE \
——https url:/ / api.lokalise.com/api2/projects/ {project_id:分支}/键/ {key_id} \--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“已删除密钥”：假，“keys_locked”：1｝

语言文字

Lokalise中有超过500种预定义的语言/方言组合。如果您需要自定义语言/方言组合使用custom_x.语言(X是1到100之间的一个数字)。您可以在添加语言时重写语言代码和名称，或者稍后更新现有的语言属性。

在某些情况下，需要将不同的语言代码导出到不同的平台(例如。zh-Hans到iOS和zh_HansWeb)。在这种情况下，您需要设置任何首选版本和ise导出参数，以根据文件格式设置语言映射。

语言对象

属性

lang_id

数字

系统中唯一的语言标识符。
lang_iso

字符串

语言/地区代码。
郎姓

字符串

语言的名字。
is_rtl.

布尔

语言是否是从右到左。
plural_forms

数组

支持的复数形式的列表。

系统语言列表

检索系统语言列表。

Url参数

限制

字符串

默认值：100

要包括的项目数量(最多5000)。
页面

字符串

默认值：1

返回从该页开始的结果。

定义

         得到
         https://api.lokalise.com/api2/system/languages
        

示例请求

curl——request GET \
——https url://api.lokalise.com/api2/system/languages\--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

标题

X-Total-Count: 538

身体

｛“语言”: [{“语言id”：640，“lang_iso”：“en”，“lang_name”：“英语”，“是什么？”：假，“plural_forms”:【“一”，“其他”]}，...... {“语言id”：597，“lang_iso”：“汝”，“lang_name”：“俄罗斯”，“是什么？”：假，“plural_forms”:【“一”，“几”，“许多”，“其他”}，}

列表项目的语言

检索项目语言列表。

Url参数

限制

字符串

默认值：100

要包括的项目数量(最多5000)。
页面

字符串

默认值：1

返回从该页开始的结果。

定义

         得到
         https://api.lokalise.com/api2/projects/{project_id:分支}/语言
        

示例请求

curl——request GET \
——https url://api.lokalise.com/api2/projects/{project_id:branch}/languages\--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

标题

X-Total-Count: 12

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”“语言”: [{“语言id”：640，“lang_iso”：“en”，“lang_name”：“英语”，“是什么？”：假“plural_forms”:【“一”，“其他”]}，...... {“语言id”：597，“lang_iso”：“汝”，“lang_name”：“俄罗斯”，“是什么？”：假“plural_forms”:【“一”，“几”，“许多”，“其他”[}]}

创造语言

在项目中创建一种或多种语言。需要管理语言管理权利。

的language_iso是一种系统语言的标识符。你只需要包括language_iso属性，但您也可以覆盖默认的语言代码、语言名称和复数形式。

属性

lang_iso

字符串要求

系统中唯一的语言代码。
custom_iso

字符串

重写语言/区域设置代码。
custom_name

字符串

重写语言名称。
custom_plural_forms

数组

覆盖此语言受支持的复数形式列表。

定义

         帖子
         https://api.lokalise.com/api2/projects/{project_id:分支}/语言
        

示例请求体

｛“语言”: [{“lang_iso”：“en”}，{“lang_iso”：“汝”}]}

示例请求

curl——请求发布\
——https url://api.lokalise.com/api2/projects/{project_id:branch}/languages\--标题“application / json内容类型:＼
--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”＼
——数据{"语言":[{“lang_iso”:“en”},{“lang_iso”:“俄罗斯”}]}”

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“语言”: [{“语言id”：640，“lang_iso”：“en”，“lang_name”：“英语”，“是什么？”：假，“plural_forms”:【“一”，“其他”}, {“语言id”：597，“lang_iso”：“汝”，“lang_name”：“俄罗斯”，“是什么？”：假，“plural_forms”:【“一”，“几”，“许多”，“其他”[}]}

检索语言

检索语言对象。

定义

         得到
         https://api.lokalise.com/api2/projects/{project_id:分支}/语言/{lang_id}
        

示例请求

curl——request GET \
——https url:/ / api.lokalise.com/api2/projects/ {project_id:分支}/语言/ {lang_id} \--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“语言”:{“语言id”：640，“lang_iso”：“en”，“lang_name”：“英语”，“是什么？”：假，“plural_forms”:【“一”，“其他”]}}

更新一个语言

更新语言的属性。需要管理语言管理权利。

属性

lang_iso

字符串

语言/地区代码。
郎姓

字符串

语言的名字。
plural_forms

数组

支持的复数形式的列表。

定义

         把
         https://api.lokalise.com/api2/projects/{project_id:分支}/语言/{lang_id}
        

示例请求体

｛“lang_iso”：“恩我们”，“plural_forms”:【“一”，“零”，“几”，“其他”]}

示例请求

curl——request PUT \
——https url:/ / api.lokalise.com/api2/projects/ {project_id:分支}/语言/ {lang_id} \--标题“application / json内容类型:＼
--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”＼
——数据”{lang_iso”:“en - us”、“plural_forms”:[“一”、“零”、“几”、“其他”]}”

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“语言”:{“语言id”：640，“lang_iso”：“恩我们”，“lang_name”：“英语”，“是什么？”：假，“plural_forms”:【“一”，“零”，“几”，“其他”]}}

删除一个语言

从项目中删除一种语言。需要管理语言管理权利。

定义

         删去
         https://api.lokalise.com/api2/projects/{project_id:分支}/语言/{lang_id}
        

示例请求

curl——request DELETE \
——https url:/ / api.lokalise.com/api2/projects/ {project_id:分支}/语言/ {lang_id} \--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“已删除语言”：符合事实的}

订单

Lokalise提供了一些人力资源翻译服务提供商，这可以帮助将您的应用程序或网站翻译成最流行的语言。你需要列出翻译服务提供商找出他们的slu，tiers和可能的语言对。你需要创建一个支付卡为了支付翻译订单。

对象的顺序

属性

订单号

字符串

唯一的订单标识符。
项目编号

字符串

项目标识符。
分支

字符串

分行名称。
付款方法

字符串

支付方式。可能的值是credit_card，team_credit，没有一个．无效的将为属性引入之前所做的订单返回。
card_id

数字

用于付款的卡的标识符。
状态

字符串

订单的状态。可能的值是进行中，完成．处理，草案如果如果dry_run＝符合事实的．
created_at.

字符串

订单创建的日期和时间。
created_at_timestamp

数字

创建订单时的Unix时间戳。
由...制作

数字

已创建订单的用户的标识符。
created_by_email

字符串

已创建订单的用户的电子邮件。
源代码\u语言\u iso

字符串

源语言代码的顺序。
target_language_isos

数组

目标语言列表。
键

数组

按顺序包含键标识符列表。
源词

对象

对象，其中对象键是目标语言iso代码，值是可翻译的字数。
扩展属性密切属性
- {关键}
  
  字符串
  
  语言iso代码。
- {value}
  
  数字
  
  可翻译字数。
供应器_段塞

字符串

翻译提供商slug。
translation_style

字符串

翻译的风格，适用于gengo仅提供程序。
translation_tier

数字

翻译的层。层依赖于提供者。
translation_tier_name

字符串

层的名字。
简报

字符串

简报。
总计

数字

以主要货币单位(美元)计算的订单总成本

列出所有订单

列出团队中所有的翻译订单。

Url参数

限制

字符串

默认值：100

要包括的项目数量(最多5000)。
页面

字符串

默认值：1

返回从该页开始的结果。

定义

         得到
         https://api.lokalise.com/api2/teams/{team_id}/订单
        

示例请求

curl——request GET \
——https url:/ / api.lokalise.com/api2/teams/ \ {team_id} /订单--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

标题

X-Total-Count: 1

身体

｛“订单”: [{“订单号”：“20181231AAA”，“项目id”：“20008339586 cded200e0d8.29879849”，“payment_method”：“credit_card”，“卡号”：12345，“地位”：“完成”，“created_at”：“2018-12-31 12:00:00(等\ / UTC)”，“created_at_timestamp”：1546257600，“created_by”：420.，“created_by_email”：“jonn@company.com”，“source_language_iso”：“恩，我们”，“target_language_isos”:【“汝”，“fr”，“它”]，“钥匙”:【12213，12214，12215，21216]，“source_words”:{“汝”：256，“fr”：222，“它”：256},“provider_slug”：“gengo”，“translation_style”：“友好”，“translation_tier”：1，“translation_tier_name”：“母语人士”，“简报”：“请翻译我们的应用程序字符串”，“总计”：177.90}]}

创建一个订单

创建翻译顺序。您必须在要下订单的项目中拥有管理权限。

属性

项目编号

字符串要求

项目标识符。
付款方法

字符串

支付方式。可能的值是credit_card(默认)或team_credit．
card_id

数字

用于付款的卡的标识符。如果需要付款方法＝credit_card．
简报

字符串要求

简报。
源代码\u语言\u iso

字符串要求

源语言代码的顺序。
target_language_isos

数组要求

目标语言列表。
键

数组要求

按顺序包含键标识符列表。
供应器_段塞

字符串要求

翻译提供商slug。
translation_tier

数字要求

翻译的层。层依赖于提供者。
dry_run

布尔

返回响应，而不实际下订单。对价格估算有用。这张卡将不收费。默认为假(生活方式)。
translation_style

字符串

只对gengo提供者。可用值是正式的，非正式的，业务，友好的．默认为友好的．

定义

         帖子
         https://api.lokalise.com/api2/teams/{team_id}/订单
        

示例请求体

｛“项目id”：“20008339586 cded200e0d8.29879849”，“卡号”：12345，“简报”：“我们应用程序的使用条款。”，“source_language_iso”：“恩，我们”，“target_language_isos”:【“汝”，“fr”，“它”]，“钥匙”:【12213，12214，12215，21216]，“provider_slug”：“gengo”，“translation_tier”：1｝

示例请求

curl——请求发布\
——https url:/ / api.lokalise.com/api2/teams/ \ {team_id} /订单--标题“application / json内容类型:＼
--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”＼
——数据'{"project_id":"20008339586cded200e0d8.29879849"，"card_id":12345，"briefing":"Terms of use of our app."，"source_language_iso":"en_US"，"target_language_iso ":["ru"，"fr"，"it"]，"keys":[12213,12214,12215,21216]，"provider_slug":"gengo"，"translation_tier":1}'

答复示例（200）

｛“订单号”：“20181231AAA”，“项目id”：“20008339586 cded200e0d8.29879849”，“payment_method”：“credit_card”，“卡号”：12345，“地位”：“进行中”，“created_at”：“2018-12-31 12:00:00(等\ / UTC)”，“created_at_timestamp”：1546257600，“created_by”：420.，“created_by_email”：“jonn@company.com”，“source_language_iso”：“恩，我们”，“target_language_isos”:【“汝”，“fr”，“它”]，“钥匙”:【12213，12214，12215，21216]，“source_words”:{“汝”：256，“fr”：222，“它”：256},“provider_slug”：“gengo”，“translation_style”：“友好”，“translation_tier”：1，“translation_tier_name”：“母语人士”，“简报”：“我们应用程序的使用条款。”，“总计”：177.90，“dry_run”：假｝

检索订单

检索一个订单对象。

定义

         得到
         https://api.lokalise.com/api2/teams/{team_id}/订单/{order_id}
        

示例请求

curl——request GET \
——https url:/ / api.lokalise.com/api2/teams/ {team_id} / {order_id} \ /订单--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

｛“订单号”：“20181231AAA”，“项目id”：“20008339586 cded200e0d8.29879849”，“payment_method”：“credit_card”，“卡号”：12345，“地位”：“进行中”，“created_at”：“2018-12-31 12:00:00(等\ / UTC)”，“created_at_timestamp”：1546257600，“created_by”：420.，“created_by_email”：“jonn@company.com”，“source_language_iso”：“恩，我们”，“target_language_isos”:【“汝”，“fr”，“它”]，“钥匙”:【12213，12214，12215，21216]，“source_words”:{“汝”：256，“fr”：222，“它”：256},“provider_slug”：“gengo”，“translation_style”：“友好”，“translation_tier”：1，“translation_tier_name”：“母语人士”，“简报”：“我们应用程序的使用条款。”，“总计”：177.90｝

付款卡

信用卡是用来支付翻译顺序．每个用户都有自己的卡片，不能与其他用户共享。我们不存储信用卡信息。一旦添加了卡，我们将详细信息发送给Stripe，并接收卡令牌，该令牌只能用于在Lokalise进行订单购买。

支付卡对象

属性

card_id

数字

卡的唯一标识符。
最后的

字符串

卡片的最后4位。
品牌

字符串

卡品牌。
created_at.

字符串

创建卡的日期/时间。
created_at_timestamp

数字

创建卡时的Unix时间戳。

创建一个卡

添加新的支付卡到用户卡。

属性

数字

数字要求

卡号。
cvc

数字要求

3位卡CVC代码。
exp_month

数字要求

信用卡到期月(1-12月)。
exp_year

数字要求

卡过期。

定义

         帖子
         https://api.lokalise.com/api2/payment_cards
        

示例请求体

｛“数量”：“4242424242424242”，“cvc”：“123”，“exp_month”：5，“exp_year”：2021｝

示例请求

curl——请求发布\
——https url:/ / api.lokalise.com/api2/payment_cards \--标题“application / json内容类型:＼
--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”＼
——数据“{”数字“：“4242”，“cvc:“123”，“经验月”：5，“经验年”：2021}”

答复示例（200）

｛“卡号”：1234，“last4”：4242，“品牌”：“签证”，“created_at”：“2018-12-31 12:00:00(等\ / UTC)”，“created_at_timestamp”：1546257600｝

列出所有的卡片

列出所有用户支付卡。

Url参数

限制

字符串

默认值：100

要包括的项目数量(最多5000)。
页面

字符串

默认值：1

返回从该页开始的结果。

定义

         得到
         https://api.lokalise.com/api2/payment_cards
        

示例请求

curl——request GET \
——https url:/ / api.lokalise.com/api2/payment_cards \--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

标题

X-Total-Count: 2

身体

｛“user_id”：420.，“payment_cards”: [{“卡号”：22192，“last4”：“5678”，“品牌”：“万事达”，“created_at”：“2018-12-31 12:00:00(等\ / UTC)”，“created_at_timestamp”：1546257600}，{“卡号”：22193，“last4”：“1234”，“品牌”：“签证”，“created_at”：“2018-12-31 12:00:00(等\ / UTC)”，“created_at_timestamp”：1546257600},]}

检索一个卡

检索支付卡对象。

定义

         得到
         https://api.lokalise.com/api2/payment_cards/{card_id}
        

示例请求

curl——request GET \
——https url:/ / api.lokalise.com/api2/payment_cards/ {card_id} \--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

｛“user_id”：420.，“支付卡”:{“卡号”：22193，“last4”：“1234”，“品牌”：“签证”，“created_at”：“2018-12-31 12:00:00(等\ / UTC)”，“created_at_timestamp”：1546257600}}

删除卡片

从用户卡中删除支付卡。

定义

         删去
         https://api.lokalise.com/api2/payment_cards/{card_id}
        

示例请求

curl——request DELETE \
——https url:/ / api.lokalise.com/api2/payment_cards/ {card_id} \--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

｛“卡号”：22193，“已删除卡片”：符合事实的｝

项目

lockalise是一个基于项目的翻译管理系统。我们建议将所有平台密钥保存在同一个项目中。上传iOS, Android，前端，后端和API语言文件-所有与某个应用程序或网站相关的东西-到同一个项目。我们为您提供钥匙合并或引用选项，让您避免重复工作的翻译。

项目对象

属性

项目编号

字符串

唯一的项目标识符。
的名字

字符串

项目名称。
描述

字符串

项目描述。
created_at.

字符串

项目创建日期。
created_at_timestamp

数字

创建项目时的Unix时间戳。
由...制作

数字

已创建项目的用户的标识符。
created_by_email

字符串

创建项目的用户的电子邮件。
team_id.

数字

项目所属团队的唯一标识符。
base_language_id

数字

项目默认语言的唯一标识符。
base_language_iso

字符串

项目默认语言的语言/区域设置代码。
设置

对象

包含项目设置的对象。
扩展属性密切属性
- per_platform_key_names
  
  布尔
  
  如果启用，项目对于不同的平台有不同的关键字名称。
- 回顾
  
  布尔
  
  如果启用贡献者对项目有评审权限。
- 向上投票
  
  布尔
  
  如果启用了，用户可以为翻译的不同变体投票。
- 自动切换未经验证
  
  布尔
  
  如果启用本地化，将自动标记翻译未经验证的情况下，基本语言的翻译被更改。
- 离线_Translation.
  
  布尔
  
  如果已启用的翻译器能够从编辑器下载并上传作为xliff文件的翻译。
- key_editing
  
  布尔
  
  如果允许启用键进行修改。
- Inline_Machine_Translations.
  
  布尔
  
  如果启用，则对所有项目用户启用联机机器翻译。
- 分支
  
  布尔
  
  如果启用，则分支将可用。
- 自定义\u翻译\u状态
  
  布尔
  
  如果已启用，则可提供自定义转换状态。
- custom_translation_statuses_allow_multiple
  
  布尔
  
  如果启用，那么将允许多个自定义翻译状态。
统计数据

对象

一个包含项目统计数据，QA问题和项目语言的对象。
扩展属性密切属性
- progress_total
  
  数字
  
  项目进度的总百分比。
- keys_total
  
  数字
  
  项目中的键数。
- 团队
  
  数字
  
  团队成员算在该项目中。
- base_words
  
  数字
  
  项目基本语言的单词数。
- qa_issues_total
  
  数字
  
  项目中QA问题的总体统计。
- 质量保证问题
  
  对象
  
  包含每个QA问题类型的计数的对象。
  扩展属性密切属性
  - 未经审核
    
    数字
    
    未审核翻译的计数。
  - 未经证实的
    
    数字
    
    未经验证的翻译计数。
  - spelling_grammar
    
    数字
    
    用拼写和/或语法错误计算翻译。
  - 不一致的占位符
    
    数字
    
    使用不一致占位符的翻译计数(源vs目标)。
  - 不一致的html
    
    数字
    
    带有不一致HTML标记的翻译计数(源vs目标)。
  - different_number_of_urls
    
    数字
    
    具有不同URL数的翻译计数（源与目标）。
  - different_urls
    
    数字
    
    使用不同的URL（源VS目标）的翻译数。
  - leading_whitespace
    
    数字
    
    带有前导空格的翻译计数。
  - trailing_whitespace
    
    数字
    
    带有尾随空格的翻译计数。
  - different_number_of_email_address
    
    数字
    
    不同电子邮件地址数的翻译计数（源与目标）。
  - different_email_address
    
    数字
    
    使用不同电子邮件地址的翻译计数(源vs目标)。
  - different_brackets
    
    数字
    
    不同括号的翻译数(源vs目标)。
  - different_numbers
    
    数字
    
    不同数量的翻译计数(源vs目标)。
  - double_space
    
    数字
    
    带双空格的翻译计数（目标）。
  - Special_PlaceHolder.
    
    数字
    
    无效使用[VOID]， [TRUE]， [FALSE]占位符的计数。
  - Unbalanced_Brackets.
    
    数字
    
    不平衡括号数(目标)。
- 语言
  
  对象
  
  项目语言的数组与进度百分比。
  扩展属性密切属性
  - 语言识别码
    
    数字
    
    系统中唯一的语言标识符。
  - language_iso
    
    字符串
    
    语言/地区代码。
  - 进步
    
    数字
    
    翻译键百分比。
  - 要做的话
    
    数字
    
    从项目基础语言翻译剩下的单词数。

列出所有的项目

检索由令牌授权的用户可用的项目列表。

Url参数

筛选团队id

字符串

将结果限制为团队ID。
filter_names.

字符串

要筛选的一个或多个项目名称(用逗号分隔)。
include_statistics

字符串

默认值：1

是否包括项目统计。可能的值是1和0．
include_settings

字符串

默认值：1

是否包含项目设置。可能的值是1和0．
限制

字符串

默认值：100

要包括的项目数量(最多5000)。
页面

字符串

默认值：1

返回从该页开始的结果。

定义

         得到
         https://api.lokalise.com/api2/projects
        

示例请求

curl——request GET \
-  url.“https://api.lokalise.com/api2/projects?filter_team_id= {filter_team_id}”＼
--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

标题

X-Total-Count: 2

身体

｛“项目”: [{“项目id”：“20008339586 cded200e0d8.29879849”，“project_type”：“localization_files”，“名称”：“SuperApp (iOS + Android)”，“描述”：＂＂，“created_at”：“2018-12-31 12:00:00(等\ / UTC)”，“created_at_timestamp”：1546257600，“created_by”：420.，“created_by_email”：“user@mycompany.com”，“team_id”：12345，“base_language_id”：640，“base_language_iso”：“en”，“设置”:{“每个平台密钥名称”：假，“审查”：假，“upvoting”：假，“auto_toggle_unverified”：符合事实的，“offline_translation”：假，“按键编辑”：符合事实的，“inline_machine_translations”：符合事实的，“custom_translation_statuses”：符合事实的，“custom_translation_statuses_allow_multiple”：假},“统计”:{“progress_total”：87，“keys_total”：13，“团队”：2，“base_words”：22，“qa_issues_total”：65，“质量保证问题”:{“not_reviewed”：39，“未经证实的”：7，“spelling_crammar”：4，“不一致的持有者”：5，“inconsistent_html”：1，“different_number_of_urls”：0，“different_urls”：1，“leading_whitespace”：1，“trailing_whitespace”：0，“different_number_of_email_address”：0，“different_email_address”：0，“不同的_brackets”：6，“different_numbers”：1，“double_space”：0，“special_placeholder”：0，“unbalanced_brackets”：0},“语言”: [{“language_id”：640，“language_iso”：“en”，“进步”：One hundred.，“words_to_do”：0}，{“language_id”：800，“language_iso”：“lv_lv”，“进步”：One hundred.，“words_to_do”：0}，{“language_id”：673，“language_iso”：“fr”，“进步”：63，“words_to_do”：8}]}}， {“项目id”：“100137835922 d7d69a98e6.35789135”，“project_type”：“localization_files”，“名称”：“营销电子邮件”，“描述”：＂＂，“created_at”：“2018-12-31 12:00:00(等\ / UTC)”，“created_at_timestamp”：1546257600，“created_by”：420.，“created_by_email”：“user@mycompany.com”，“team_id”：12345，“base_language_id”：640，“base_language_iso”：“en”，“设置”:{“每个平台密钥名称”：假，“审查”：假，“upvoting”：假，“auto_toggle_unverified”：符合事实的，“offline_translation”：假，“按键编辑”：符合事实的，“inline_machine_translations”：符合事实的，“custom_translation_statuses”：符合事实的，“custom_translation_statuses_allow_multiple”：假},“统计”:{“progress_total”：87，“keys_total”：13，“团队”：2，“base_words”：22，“qa_issues_total”：65，“质量保证问题”:{“not_reviewed”：39，“未经证实的”：7，“spelling_crammar”：4，“不一致的持有者”：5，“inconsistent_html”：1，“different_number_of_urls”：0，“different_urls”：1，“leading_whitespace”：1，“trailing_whitespace”：0，“different_number_of_email_address”：0，“different_email_address”：0，“不同的_brackets”：6，“different_numbers”：1，“double_space”：1，“special_placeholder”：0，“unbalanced_brackets”：0},“语言”: [{“language_id”：640，“language_iso”：“en”，“进步”：One hundred.，“words_to_do”：0}，{“language_id”：800，“language_iso”：“lv_lv”，“进步”：One hundred.，“words_to_do”：0}，{“language_id”：673，“language_iso”：“fr”，“进步”：63，“words_to_do”：8}]}，}

创建一个项目

在指定的团队中创建一个新项目。需要管理在团队中的角色。

属性

的名字

字符串要求

项目名称。
team_id.

数字

要在其中创建项目的团队ID。如果省略此参数，则将在指定了API令牌的用户的当前团队中创建项目。
描述

字符串

项目描述。
语言

对象

添加语言列表。
扩展属性密切属性
- lang_iso
  
  字符串要求
  
  系统中唯一的语言代码。
- custom_iso
  
  字符串
  
  重写语言/区域设置代码。
base_lang_iso.

字符串

默认值：en

项目基础语言的语言/地区代码。应该在范围内语言列表。使用custom_iso代码，以便它定义。
project_type

字符串

默认值:localization_files

项目类型。允许的值是localization_files，paged_documents

定义

         帖子
         https://api.lokalise.com/api2/projects
        

示例请求体

｛“名称”：“TheApp项目”，“描述”：iOS + Android字符串的TheApp。https://theapp.com”，“语言”: [{“lang_iso”：“en”，“custom_iso”：“en - us”}，{“lang_iso”：“en_gb”，“custom_iso”：“en-gb”} ],“base_lang_iso”：“en - us”｝

示例请求

curl——请求发布\
——https url:/ / api.lokalise.com/api2/projects \--标题“application / json内容类型:＼
--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”＼
——数据'{"name":"TheApp Project"，"description":"iOS + Android字符串的TheApp。https://theapp.com”、“语言”:[{“lang_iso”:“en”,“custom_iso”:“en - us”},{“lang_iso”:“en_GB”、“custom_iso”:“en”}],“base_lang_iso”:“en - us”}’

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“project_type”：“localization_files”，“名称”：“TheApp项目”，“描述”：iOS + Android字符串的TheApp。https://theapp.com”，“created_at”：“2018-12-31 12:00:00(等\ / UTC)”，“created_at_timestamp”：1546257600，“created_by”：420.，“created_by_email”：“user@mycompany.com”，“team_id”：12345，“base_language_id”：640，“base_language_iso”：“en - us”，“设置”:{“每个平台密钥名称”：假，“审查”：假，“upvoting”：假，“auto_toggle_unverified”：符合事实的，“offline_translation”：假，“按键编辑”：符合事实的，“inline_machine_translations”：符合事实的，“custom_translation_statuses”：符合事实的，“custom_translation_statuses_allow_multiple”：假},“统计”:{“progress_total”：0，“keys_total”：0，“团队”：1，“base_words”：0，“qa_issues_total”：0，“质量保证问题”:{“not_reviewed”：0，“未经证实的”：0，“spelling_crammar”：0，“不一致的持有者”：0，“inconsistent_html”：0，“different_number_of_urls”：0，“different_urls”：0，“leading_whitespace”：0，“trailing_whitespace”：0，“different_number_of_email_address”：0，“different_email_address”：0，“不同的_brackets”：0，“different_numbers”：0，“double_space”：1，“special_placeholder”：0，“unbalanced_brackets”：0},“语言”: [{“language_id”：640，“language_iso”：“en - us”，“进步”：0，“words_to_do”：0}，{“language_id”：610，“language_iso”：“en-gb”，“进步”：0，“words_to_do”：0}]}}

检索一个项目

检索项目对象。

定义

         得到
         https://api.lokalise.com/api2/projects/{project_id}
        

示例请求

curl——request GET \
——https url://api.lokalise.com/api2/projects/ {project_id} \--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“project_type”：“localization_files”，“名称”：“TheApp项目”，“描述”：iOS + Android字符串的TheApp。https://theapp.com”，“created_at”：“2018-12-31 12:00:00(等\ / UTC)”，“created_at_timestamp”：1546257600，“created_by”：420.，“created_by_email”：“user@mycompany.com”，“team_id”：12345，“base_language_id”：640，“base_language_iso”：“en”，“设置”:{“每个平台密钥名称”：假，“审查”：假，“upvoting”：假，“auto_toggle_unverified”：符合事实的，“offline_translation”：假，“按键编辑”：符合事实的，“inline_machine_translations”：符合事实的，“custom_translation_statuses”：符合事实的，“custom_translation_statuses_allow_multiple”：假},“统计”:{“progress_total”：87，“keys_total”：13，“团队”：2，“base_words”：22，“qa_issues_total”：65，“质量保证问题”:{“not_reviewed”：39，“未经证实的”：7，“spelling_crammar”：4，“不一致的持有者”：5，“inconsistent_html”：1，“different_number_of_urls”：0，“different_urls”：1，“leading_whitespace”：1，“trailing_whitespace”：0，“different_number_of_email_address”：0，“different_email_address”：0，“不同的_brackets”：6，“different_numbers”：1，“double_space”：1，“special_placeholder”：0，“unbalanced_brackets”：0},“语言”: [{“language_id”：640，“language_iso”：“en”，“进步”：One hundred.，“words_to_do”：0}，{“language_id”：800，“language_iso”：“lv_lv”，“进步”：One hundred.，“words_to_do”：0}，{“language_id”：673，“language_iso”：“fr”，“进步”：63，“words_to_do”：8}]}}

更新一个项目

更新项目的详细信息。需要管理设置管理权利。

属性

的名字

字符串要求

项目名称。
描述

字符串

项目描述。

定义

         把
         https://api.lokalise.com/api2/projects/{project_id}
        

示例请求体

｛“名称”：“TheZapp项目”，“描述”：iOS + Android串的TheZapp。https://thezapp.com”｝

示例请求

curl——request PUT \
——https url://api.lokalise.com/api2/projects/ {project_id} \--标题“application / json内容类型:＼
--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”＼
——数据“{”name:“TheZapp项目”，“description:“TheZapp的iOS+Android字符串”。https://thezapp.com"}'

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“project_type”：“localization_files”，“名称”：“TheApp项目”，“描述”：iOS + Android字符串的TheApp。https://theapp.com”，“created_at”：“2018-12-31 12:00:00(等\ / UTC)”，“created_at_timestamp”：1546257600，“created_by”：420.，“created_by_email”：“user@mycompany.com”，“team_id”：12345，“base_language_id”：640，“base_language_iso”：“en”，“设置”:{“每个平台密钥名称”：假，“审查”：假，“upvoting”：假，“auto_toggle_unverified”：符合事实的，“offline_translation”：假，“按键编辑”：符合事实的，“inline_machine_translations”：符合事实的，“custom_translation_statuses”：符合事实的，“custom_translation_statuses_allow_multiple”：假},“统计”:{“progress_total”：87，“keys_total”：13，“团队”：2，“base_words”：22，“qa_issues_total”：65，“质量保证问题”:{“not_reviewed”：39，“未经证实的”：7，“spelling_crammar”：4，“不一致的持有者”：5，“inconsistent_html”：1，“different_number_of_urls”：0，“different_urls”：1，“leading_whitespace”：1，“trailing_whitespace”：0，“different_number_of_email_address”：0，“different_email_address”：0，“不同的_brackets”：6，“different_numbers”：1，“double_space”：1，“special_placeholder”：0，“unbalanced_brackets”：0},“语言”: [{“language_id”：640，“language_iso”：“en”，“进步”：One hundred.，“words_to_do”：0}，{“language_id”：800，“language_iso”：“lv_lv”，“进步”：One hundred.，“words_to_do”：0}，{“language_id”：673，“language_iso”：“fr”，“进步”：63，“words_to_do”：8}]}}

空的一个项目

从项目中删除所有键和翻译。要求管理设置管理权利。

定义

         把
         https://api.lokalise.com/api2/projects/{project_id:分支}/空
        

示例请求

curl——request PUT \
——https url:/ / api.lokalise.com/api2/projects/ {project_id:分支}/空\--标题“application / json内容类型:＼
--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“keys_deleted”：符合事实的｝

删除一个项目

删除一个项目。

定义

         删去
         https://api.lokalise.com/api2/projects/{project_id}
        

示例请求

curl——request DELETE \
——https url://api.lokalise.com/api2/projects/ {project_id} \--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“project_deleted”：符合事实的}

排队过程

繁重的操作(例如文件导入)将排队等待处理。有关这些排队进程的信息可以通过API检索。

Queued processes对象

属性

process_id

字符串

唯一的进程标识符。
类型

字符串

流程的类型。可以点击文件，sketch-import或批量应用-TM．
状态

字符串

进程的当前状态。可以排队，pre_processing，跑步，post_processing，取消了，完成了或失败的．
信息

字符串

可以包含与当前进程状态相关的消息(如错误消息)。
由...制作

数字

启动该进程的用户的ID。
created_by_email

字符串

发起该流程的用户的电子邮件。
created_at.

字符串

在队列中创建进程的日期。
created_at_timestamp

数字

在队列中创建进程的时间戳。

列出所有流程

的列表排队过程对象。

Url参数

限制

字符串

默认值：100

要包括的项目数量(最多5000)。
页面

字符串

默认值：1

返回从该页开始的结果。

定义

         得到
         https://api.lokalise.com/api2/projects/{project_id:分支}/流程
        

示例请求

curl——request GET \
——https url:/ / api.lokalise.com/api2/projects/ \ {project_id:分支}/流程--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

标题

X-分页-总计数：2

身体

｛“项目id”：“767946315 e9866d013c1d0.08299127”，“进程”: [{“process_id”：“2 e0559e60e856555fbc15bdf78ab2b0ca3406e8f”，“类型”：“文件导入”，“地位”：“完成”，“消息”：＂＂，“created_by”：1234，“created_by_email”：“example@example.com”，“created_at”：“2020-04-20 13:43:43（Etc/UTC）”，“created_at_timestamp”：1587390223}，{“process_id”：“f70bbf40059386a568d42c0f80297477e252cc48”，“类型”：“文件导入”，“地位”：“完成”，“消息”：＂＂，“created_by”：1234，“created_by_email”：“example@example.com”，“created_at”：“2020-04-20 13:48:00（etc / utc）”，“created_at_timestamp”：1587390480}]}

检索过程

检索排队过程对象的附加细节包含特定流程类型信息的字段。

定义

         得到
         https://api.lokalise.com/api2/projects/{project_id:分支}/进程/{process_id}
        

示例请求

curl——request GET \
——https url://api.lokalise.com/api2/projects/{project\u id:branch}/processs/{process\u id}\--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

｛“项目id”：“767946315 e9866d013c1d0.08299127”，“过程”:{“process_id”：“2 e0559e60e856555fbc15bdf78ab2b0ca3406e8f”，“类型”：“文件导入”，“地位”：“完成”，“消息”：＂＂，“created_by”：1234，“created_by_email”：“example@example.com”，“created_at”：“2020-04-20 13:43:43（Etc/UTC）”，“created_at_timestamp”：1587390223，“细节”:{“文件”: [{“地位”：“完成”，“消息”：＂＂，“name_original”：“index.json”，“name_custom”：“index.json”，“word_count_total”：2，“密钥\u计数\u总数”：1，“key_count_inserted”：0，“key_count_updated”：0，“key_count_skipped”：1}]}}

截图

截图对象

属性

screenshot_id

数字

屏幕截图的唯一标识符。
key_ids

数组

键标识符列表，截屏附加到。
键

数组

带有坐标的键的列表。
网址

字符串

链接到屏幕截图。
标题

字符串

截图标题。
描述

字符串

对截图的描述。
screenshot_tags

数组

截图标签列表。
宽度

数字

屏幕截图的宽度，以像素为单位。
身高

数字

截屏的高度，以像素为单位。
created_at.

字符串

创建日期的截图。
created_at_timestamp

数字

创建截图时的Unix时间戳。

列出所有截图

从项目中检索截图列表。

Url参数

限制

字符串

默认值：100

要包括的项目数量(最多5000)。
页面

字符串

默认值：1

返回从该页开始的结果。

定义

         得到
         https://api.lokalise.com/api2/projects/{project_id}/截图
        

示例请求

curl——request GET \
——https url:/ / api.lokalise.com/api2/projects/ {project_id} /截图\--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

标题

X-Total-Count: 2

身体

｛“项目id”：“20008339586 cded200e0d8.29879849”，“截图”: [{“screenshot_id”：403021，“数据”：＂＂，“标题”：“欢迎屏幕”，“描述”：＂＂，“key_ids”:【1132290，1132292，1132293]，“钥匙”: [{密钥id：1132290，协调：无效的}，{密钥id：1132292，协调：无效的}，{密钥id：1132293，协调:{左：10，前：10，宽度：One hundred.，身高：One hundred.，}}]，“screenshot_tags”:【“onboarding”，“主要”]，“宽度”：1024，“高度”：768，“created_at”：“2019-02-01 12:00:00(等\ / UTC)”，“created_at_timestamp”：1546257600}，{“screenshot_id”：403022，“标题”：“登录屏幕”，“描述”：＂＂，“key_ids”:【1132290，1132292，1132293]，“钥匙”: [{密钥id：1132290，协调：无效的}，{密钥id：1132292，协调：无效的}，{密钥id：1132293，协调:{左：10，前：10，宽度：One hundred.，身高：One hundred.，}}]，“screenshot_tags”:【“onboarding”，“主要”]，“宽度”：1024，“高度”：768，“created_at”：“2019-02-01 12:00:00(等\ / UTC)”，“created_at_timestamp”：1546257600}]}

创建屏幕截图

在项目中创建一个或多个屏幕截图。需要管理截图管理权利。

属性

数据

字符串要求

这个截图，base64编码(带有前导图像类型数据：图像/jpeg；base64，）.支持的文件格式为JPG、PNG。
标题

字符串

设置截图标题(可选)。
描述

字符串

设置截图描述。
光学字符识别

布尔

默认值:真正的

尝试识别图像上的翻译，并附上截图到所有可能的键。
key_ids

数组

将截图附加到指定的键id。
标签

数组

要添加到上载屏幕截图的标记列表。

定义

         帖子
         https://api.lokalise.com/api2/projects/{project_id}/截图
        

示例请求体

｛“截图”: [{“数据”：“数据：图像/ jpeg; base64，d94bwwgdmvyc2lvbj0ims4wiiblbmnvzgluzz0ivvrgl ......”，“ocr”：假，“key_ids”:【1132290，1132292，1132293]，“标签”:【“onboarding”[}]}

示例请求

curl——请求发布\
——https url:/ / api.lokalise.com/api2/projects/ {project_id} /截图\--标题“application / json内容类型:＼
--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”＼
——数据'{“屏幕截图”：[{“数据”：“数据：图像/ jpeg; base64，d94bwwgdmvyc2lvbj0ims4wiiblbmnvzgluzz0ivvrgl .....”，“ocr”：false，“key_ids”：[1132290,1132292,1132293]，“标签”：[“onboarding”]}]}'

答复示例（200）

｛“项目id”：“20008339586 cded200e0d8.29879849”，“截图”: [{“screenshot_id”：403021，“url”：“https://s3 -欧盟-西方- 1. - amazonaws.com/files/screenshots/welcome.jpg”，“key_ids”:【1132290，1132292，1132293]，“钥匙”: [{密钥id：1132290，协调：无效的}，{密钥id：1132292，协调：无效的}，{密钥id：1132293，协调:{左：10，前：10，宽度：One hundred.，身高：One hundred.，}}]，“标题”：“欢迎屏幕”，“描述”：＂＂，“screenshot_tags”:【“onboarding”]，“宽度”：1024，“高度”：768，“created_at”：“2019-02-01 12:00:00(等\ / UTC)”，“created_at_timestamp”：1546257600}]}

检索一个截图

检索截图对象。

定义

         得到
         https://api.lokalise.com/api2/projects/{project_id}/截图/{screenshot_id}
        

示例请求

curl——request GET \
——https url://api.lokalise.com/api2/projects/ {project_id} /screenshots/ {screenshot_id} \--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

｛“项目id”：“20008339586 cded200e0d8.29879849”，“截图”:{“screenshot_id”：403021，“url”：“https://s3 -欧盟-西方- 1. - amazonaws.com/files/screenshots/welcome.jpg”，“key_ids”:【1132290，1132292，1132293]，“钥匙”: [{密钥id：1132290，协调：无效的}，{密钥id：1132292，协调：无效的}，{密钥id：1132293，协调:{左：10，前：10，宽度：One hundred.，身高：One hundred.，}}]，“标题”：“欢迎屏幕”，“描述”：＂＂，“screenshot_tags”:【“onboarding”]，“宽度”：1024，“高度”：768，“created_at”：“2019-02-01 12:00:00(等\ / UTC)”，“created_at_timestamp”：1546257600}}

更新一个截图

更新截图的属性。需要管理截图管理权利。

属性

标题

字符串

设置截图标题(可选)。
描述

字符串

设置截图描述。
key_ids

数组

将截图附加到指定的键id。
标签

数组

要添加到上载屏幕截图的标记列表。

定义

         把
         https://api.lokalise.com/api2/projects/{project_id:分支}/截图/{screenshot_id}
        

示例请求体

｛“key_ids”:【1132290，1132292]，“标签”:【“主要”]}

示例请求

curl——request PUT \
——https url://api.lokalise.com/api2/projects/{project_id:branch}/screenshots/{screenshot_id}\--标题“application / json内容类型:＼
--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”＼
——数据“{”key_id:[1132290113292]，“tags:[“main”]}”

答复示例（200）

｛“项目id”：“20008339586 cded200e0d8.29879849”，“截图”:{“screenshot_id”：403021，“url”：“https://s3 -欧盟-西方- 1. - amazonaws.com/files/screenshots/welcome.jpg”，“key_ids”:【1132290，1132292]，“钥匙”: [{密钥id：1132290，协调：无效的}，{密钥id：1132292，协调：无效的}，{密钥id：1132293，协调:{左：10，前：10，宽度：One hundred.，身高：One hundred.，}}]，“标题”：“欢迎屏幕”，“描述”：＂＂，“screenshot_tags”:【“主要”]，“宽度”：1024，“高度”：768，“created_at”：“2019-02-01 12:00:00(等\ / UTC)”，“created_at_timestamp”：1546257600}}

删除一个截图

从项目中删除截图。需要管理截图管理权利。

定义

         删去
         https://api.lokalise.com/api2/projects/{project_id}/截图/{screenshot_id}
        

示例请求

curl——request DELETE \
——https url://api.lokalise.com/api2/projects/ {project_id} /screenshots/ {screenshot_id}

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“screenshot_deleted”：符合事实的｝

快照

快照对象

属性

snapshot_id

数字

快照的唯一标识符。
标题

字符串

快照标题。
created_at.

字符串

创建快照的日期和时间。
created_at_timestamp

字符串

创建快照时UNIX时间戳。
由...制作

数字

已创建快照的用户标识符。
created_by_email

字符串

用户创建了快照的用户的电子邮件。

列出所有快照

检索项目快照列表。需要管理设置管理权利。

Url参数

限制

字符串

默认值：100

要包括的项目数量(最多5000)。
页面

字符串

默认值：1

返回从该页开始的结果。

定义

         得到
         https://api.lokalise.com/api2/projects/{project_id}/快照
        

示例请求

curl——request GET \
——https url://api.lokalise.com/api2/projects/ {project_id} /snapshots \--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

标题

X-Total-Count: 2

身体

｛“项目id”：“20008339586 cded200e0d8.29879849”，“快照”: [{“snapshot_id”：1523966589，“标题”：“API快照”，“created_at”：“2018-12-31 12:00:00(等\ / UTC)”，“created_at_timestamp”：1546257600，“created_by”：420.，“created_by_email”：“user@mycompany.com”}，{“snapshot_id”：1523966599，“标题”：“API快照”，“created_at”：“2018-12-31 12:00:00(等\ / UTC)”，“created_at_timestamp”：1546257600，“created_by”：420.，“created_by_email”：“user@mycompany.com”}]}

创建一个快照

创建项目的快照。需要管理设置管理权利。

属性

标题

字符串

设置快照标题。

定义

         帖子
         https://api.lokalise.com/api2/projects/{project_id}/快照
        

示例请求体

｛“标题”：“API快照”｝

示例请求

curl——请求发布\
——https url://api.lokalise.com/api2/projects/ {project_id} /snapshots \--标题“application / json内容类型:＼
--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”＼
——数据{“标题”:“API快照”}”

答复示例（200）

｛“项目id”：“20008339586 cded200e0d8.29879849”，“快照”:{“snapshot_id”：1523966599，“标题”：“API快照”，“created_at”：“2018-12-31 12:00:00(等\ / UTC)”，“created_at_timestamp”：1546257600，“created_by”：420.，“created_by_email”：“user@mycompany.com”}}

恢复快照

将业务快照恢复到业务副本。需要管理设置管理权利和管理在团队中的角色。

定义

         帖子
         https://api.lokalise.com/api2/projects/{project_id}/ /快照{snapshot_id}
        

示例请求

curl——请求发布\
——https url://api.lokalise.com/api2/projects/ {project_id} /snapshots/ {snapshot_id} \--标题“application / json内容类型:＼
--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“project_type”：“localization_files”，“名称”：“TheApp项目复制”，“描述”：iOS + Android字符串的TheApp。https://theapp.com”，“created_at”：“2018-12-13 12:00:00(等\ / UTC)”，“created_at_timestamp”：1546257600，“created_by”：420.，“created_by_email”：“user@mycompany.com”，“team_id”：12345，“base_language_id”：640，“base_language_iso”：“en”，“设置”:{“每个平台密钥名称”：假，“审查”：假，“upvoting”：假，“auto_toggle_unverified”：符合事实的，“offline_translation”：假，“按键编辑”：符合事实的，“inline_machine_translations”：符合事实的，“custom_translation_statuses”：符合事实的，“custom_translation_statuses_allow_multiple”：假},“统计”:{“progress_total”：87，“keys_total”：13，“团队”：2，“base_words”：22，“qa_issues_total”：65，“质量保证问题”:{“not_reviewed”：39，“未经证实的”：7，“spelling_crammar”：4，“不一致的持有者”：5，“inconsistent_html”：1，“different_number_of_urls”：0，“different_urls”：1，“leading_whitespace”：1，“trailing_whitespace”：0，“different_number_of_email_address”：0，“different_email_address”：0，“不同的_brackets”：6，“different_numbers”：1，“double_space”：1，“special_placeholder”：0，“unbalanced_brackets”：0},“语言”: [{“language_id”：640，“language_iso”：“en”，“进步”：One hundred.，“words_to_do”：0}，{“language_id”：800，“language_iso”：“lv_lv”，“进步”：One hundred.，“words_to_do”：0}，{“language_id”：673，“language_iso”：“fr”，“进步”：63，“words_to_do”：8}]}}

删除快照

删除项目快照。需要管理设置管理权利。

定义

         删去
         https://api.lokalise.com/api2/projects/{project_id}/ /快照{snapshot_id}
        

示例请求

curl——request DELETE \
——https url://api.lokalise.com/api2/projects/{project\u id}/snapshots/{snapshot\u id}

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“snapshot_deleted”：符合事实的｝

任务

任务对象

属性

任务id

数字

唯一的任务标识符。
标题

字符串

任务标题。
描述

字符串

任务的简短描述。
状态

字符串

任务的状态。允许的值是完成，进行中，创建，排队．
进步

数字

任务进度百分比(0% - 100%)。
due_date

字符串

到期日期。
到期日时间戳

数字

截止日期的UNIX时间戳。
keys_count

数字

任务中键的总数。
words_count

数字

任务中源词的总数。
created_at.

字符串

创建任务的日期和时间。
created_at_timestamp

数字

创建任务时的Unix时间戳。
由...制作

数字

已创建任务的用户的标识符。
created_by_email

字符串

创建任务的用户的电子邮件。
can_be_parent

布尔

可以将任务分配为父任务。
task_type

字符串

翻译或回顾．
parent_task_id

数字

父任务ID。
closing_tags

数组

在关闭任务时将添加到受影响密钥的标记。
是否锁定翻译

布尔

如果设置为true，将锁定非分配项目成员的翻译。
语言

对象

任务中的语言列表。
扩展属性密切属性
- language_iso
  
  字符串
  
  语言代码。
- 用户
  
  对象
  
  指定学习该语言的用户列表。
  扩展属性密切属性
  - 用户身份
    
    数字
    
    用户的唯一标识符。
  - 电子邮件
    
    字符串
    
    用户的电子邮件。
  - fullname
    
    字符串
    
    用户的全名。
- 组
  
  对象
  
  指定学习语言的小组名单。
  扩展属性密切属性
  - id
    
    数字
    
    用户组的唯一标识符。
  - 的名字
    
    字符串
    
    组名。
- 键
  
  数组
  
  键标识符列表，包括在此语言的任务中。
- 状态
  
  字符串
  
  任务中语言的状态。允许的值是完成，进行中，创建．
- 进步
  
  数字
  
  语言进步百分比(0% - 100%)。
- initial_tm_leverage.
  
  对象
  
  翻译内存利用率（已弃用）。
  扩展属性密切属性
  - 0％+
    
    数字
    
    TM匹配的字数从0%到60%。
  - 60% +
    
    数字
    
    TM匹配词数60% ~ 75%。
  - 75% +
    
    数字
    
    TM匹配的字数从75%到95%。
  - 95% +
    
    数字
    
    TM匹配的单词数量为95％至100％。
  - 100％
    
    数字
    
    与TM 100%匹配的字数。
- keys_count
  
  数字
  
  语言的键数。
- words_count
  
  数字
  
  语言源词的数量。
- completed_at
  
  字符串
  
  语言完成的日期和时间。
- 已完成_at_timestamp.
  
  数字
  
  语言完成时的Unix时间戳。
- completed_by
  
  数字
  
  已完成语言的用户的标识符。
- 完成_by_email.
  
  字符串
  
  用户已完成语言的电子邮件。
源代码\u语言\u iso

字符串

任务的源语言代码。
auto_close_languages

布尔

在完成最后一项时，是否应该自动关闭语言。
auto_close_task

布尔

任务是否应该在所有语言完成时自动关闭。
auto_close_items

布尔

是否翻译任务项应在编辑时自动标记为已完成。
completed_at

字符串

任务完成的日期和时间。
已完成_at_timestamp.

数字

任务完成时的Unix时间戳。
completed_by

数字

完成任务的用户的标识符。
完成_by_email.

字符串

已完成任务的用户的电子邮件。
custom_translation_status_ids

数组

在任务项完成后应用于任务项的自定义翻译状态id。

列出所有任务

列出项目中的所有任务。

Url参数

过滤标题

字符串

为列表设置标题过滤器。
filter_statuses

字符串

要筛选的一个或多个任务状态(以逗号分隔)。可能的值是创建，排队，in_progress*和完成．

* API响应返回进行中地位不＿．
限制

字符串

默认值：100

要包括的项目数量(最多5000)。
页面

字符串

默认值：1

返回从该页开始的结果。

定义

         得到
         https://api.lokalise.com/api2/projects/{project_id:分支}/任务
        

示例请求

curl——request GET \
——https url:/ / api.lokalise.com/api2/projects/ \ {project_id:分支}/任务--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

标题

X-Total-Count: 1

身体

｛“项目id”：“20008339586 cded200e0d8.29879849”，“任务”: [{“任务id”：55392，“标题”：“语音留言”，“can_be_parent”：假，“task_type”：“翻译”，“parent_task_id”：12345，“closing_tags”:【“标记一”，“tag_two”]，“do_lock_translations”：假，“描述”："需要你帮忙翻译一些语音信息。谢谢!”，“地位”：“进行中”，“进步”：25，“due_date”：“2018-12-31 12:00:00(等\ / UTC)”，“den_date_timestamp”：1546257600，“keys_count”：3.，“words_count”：91，“created_at”：“2018-12-31 12:00:00(等\ / UTC)”，“created_at_timestamp”：1546257600，“created_by”：420.，“created_by_email”：“manager@yourcompany.com”，“语言”: [{“language_iso”：" fi "，“用户”: [{“user_id”：421.，“电子邮件”：“jdoe@mycompany.com”，“全名”：“John Doe”} ],“群体”: [{“ID”：191，“名称”：“语音邮件翻译”} ],“钥匙”:【11212，11241，11245]，“地位”：“创建”，“进步”：0，“initial_tm_leverage”:{“0% +”：91，“60% +”：0，“75% +”：0，"95%+"：0，“100%”：0},“keys_count”：3.，“words_count”：91，“completed_at”：无效的，“completed_at_timestamp”：无效的，“completed_by”：无效的，“completed_by_email”：无效的}，{“language_iso”：“汝”，“用户”: [{“user_id”：422.，“电子邮件”：“jfox@mycompany.com”，“全名”：“詹姆斯·福克斯”} ],“群体”:[],“钥匙”:【11212，11241，11245]，“地位”：“进行中”，“进步”：80，“initial_tm_leverage”:{“0% +”：91，“60% +”：0，“75% +”：0，"95%+"：0，“100%”：0},“keys_count”：3.，“words_count”：91，“completed_at”：无效的，“completed_at_timestamp”：无效的，“completed_by”：无效的，“completed_by_email”：无效的} ],“source_language_iso”：“en”，“auto_close_languages”：符合事实的，“auto_close_task”：符合事实的，“auto_close_items”：符合事实的，“completed_at”：无效的，“completed_at_timestamp”：无效的，“completed_by”：无效的，“completed_by_email”：无效的，“自定义\u翻译\u状态\u ID”:【77，85，86[}]}

创建任务

在项目中创建任务。需要管理任务管理权利。请记住initial_tm_leverage.属性将在服务器响应中为空。它是在任务创建后计算的，这个过程可能需要一些时间。

属性

标题

字符串要求

任务标题。
描述

字符串

任务的简短描述。
due_date

字符串

到期日期在Y-m-d H:i:s格式。例如:“2018-12-24 23:59:59”
键

数组

任务中包含的键标识符列表。如果需要parent_task_id未指定
语言

对象要求

任务中的语言列表。必须提供一个“用户”或“组”。
扩展属性密切属性
- language_iso
  
  字符串要求
  
  语言代码。
- 用户
  
  数组
  
  分配用于处理该语言的用户标识符列表。
- 组
  
  数组
  
  指定用于处理该语言的用户组标识符列表。
源代码\u语言\u iso

字符串

任务的源语言代码。如果没有提供，则返回到项目基础语言。
auto_close_languages

布尔

默认值:真正的

在完成最后一项时，是否应该自动关闭语言。
auto_close_task

布尔

默认值:真正的

任务是否应该在所有语言完成时自动关闭。
auto_close_items

布尔

默认值:真正的

是否翻译任务项应在编辑时自动标记为已完成。
task_type

字符串

指定任务类型是否为翻译(默认)或回顾．
parent_task_id

数字

如果task_type是回顾，它可以有一个父任务。当父任务关闭时，当前任务将被打开。
closing_tags

数组

在关闭任务时将添加到受影响密钥的标记。
是否锁定翻译

布尔

如果设置为true，将锁定非分配项目成员的翻译。
custom_translation_status_ids

数组

在任务项完成后应用于任务项的自定义翻译状态id。

定义

         帖子
         https://api.lokalise.com/api2/projects/{project_id:分支}/任务
        

示例请求体

｛“标题”：“语音留言”，“描述”："需要你帮忙翻译一些语音信息。谢谢!”，“due_date”：“2018-12-31 12:00:00”，“钥匙”:【11212，11241，11245]，“语言”: [{“language_iso”：" fi "，“用户”:【421.}, {“language_iso”：“汝”，“群体”:【191}),“source_language_iso”：“en”，“auto_close_languages”：符合事实的，“auto_close_task”：符合事实的，“auto_close_items”：符合事实的，“task_type”：“翻译”，“parent_task_id”：12345，“closing_tags”:【“标记一”，“tag_two”]，“do_lock_translations”：符合事实的，“自定义\u翻译\u状态\u ID”:【77，85，86]}

示例请求

curl——请求发布\
——https url:/ / api.lokalise.com/api2/projects/ \ {project_id:分支}/任务--标题“application / json内容类型:＼
--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”＼
——数据{"title":"Voicemail messages"，"description":"需要您帮助翻译一些语音邮件信息。"谢谢!”、“due_date”:“2018-12-3112:00:00”、“钥匙”:(11212、11241、11245),“语言”:[{“language_iso”:" fi ", "用户":[421]},{“language_iso”:“俄罗斯”,“组织”:[191]}],“source_language_iso”:“en”、“auto_close_languages”:真的,”auto_close_task”:真的,”auto_close_items”:真的,”task_type”:“翻译”、“parent_task_id”:12345年,“closing_tags”:“tag_one”、“tag_two”,“do_lock_translations custom_tr“:真的,”anslation_status_ids”(77、85、86):}’

答复示例（200）

｛“项目id”：“20008339586 cded200e0d8.29879849”，“任务”:{“任务id”：55392，“标题”：“语音留言”，“描述”："需要你帮忙翻译一些语音信息。谢谢!”，“地位”：“进行中”，“进步”：0，“can_be_parent”：符合事实的，“task_type”：“审查”，“parent_task_id”：12345，“closing_tags”:【“标记一”，“tag_two”]，“do_lock_translations”：符合事实的，“due_date”：“2018-12-31 12:00:00(等\ / UTC)”，“den_date_timestamp”：1546257600，“keys_count”：3.，“words_count”：91，“created_at”：“2018-12-31 12:00:00(等\ / UTC)”，“created_at_timestamp”：1546257600，“created_by”：420.，“created_by_email”：“manager@yourcompany.com”，“语言”: [{“language_iso”：" fi "，“用户”: [{“user_id”：421.，“电子邮件”：“jdoe@mycompany.com”，“全名”：“John Doe”} ],“群体”:[],“钥匙”:【11212，11241，11245]，“地位”：“创建”，“进步”：0，“initial_tm_leverage”:{“0% +”：0，“60% +”：0，“75% +”：0，"95%+"：0，“100%”：0},“keys_count”：3.，“words_count”：91，“completed_at”：无效的，“completed_at_timestamp”：无效的，“completed_by”：无效的，“completed_by_email”：无效的}，{“language_iso”：“汝”，“用户”:[],“群体”: [{“ID”：191，“名称”：“语音邮件翻译”} ],“钥匙”:【11212，11241，11245]，“地位”：“进行中”，“进步”：0，“initial_tm_leverage”:{“0% +”：0，“60% +”：0，“75% +”：0，"95%+"：0，“100%”：0},“keys_count”：3.，“words_count”：91，“completed_at”：无效的，“completed_at_timestamp”：无效的，“completed_by”：无效的，“completed_by_email”：无效的} ],“source_language_iso”：“en”，“auto_close_languages”：符合事实的，“auto_close_task”：符合事实的，“auto_close_items”：符合事实的，“completed_at”：无效的，“completed_at_timestamp”：无效的，“completed_by”：无效的，“completed_by_email”：无效的，“自定义\u翻译\u状态\u ID”:【77，85，86]}}

检索一个任务

检索任务对象。

定义

         得到
         https://api.lokalise.com/api2/projects/{project_id:分支}/任务/{task_id}
        

示例请求

curl——request GET \
——https url:/ / api.lokalise.com/api2/projects/ {project_id:分支}/ {task_id} \ /任务--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

｛“项目id”：“20008339586 cded200e0d8.29879849”，“任务”:{“任务id”：55392，“标题”：“语音留言”，“描述”："需要你帮忙翻译一些语音信息。谢谢!”，“地位”：“进行中”，“进步”：80，“can_be_parent”：符合事实的，“task_type”：“审查”，“parent_task_id”：12345，“closing_tags”:【“标记一”，“tag_two”]，“do_lock_translations”：假，“due_date”：“2018-12-31 12:00:00(等\ / UTC)”，“den_date_timestamp”：1546257600，“keys_count”：3.，“words_count”：91，“created_at”：“2018-12-31 12:00:00(等\ / UTC)”，“created_at_timestamp”：1546257600，“created_by”：420.，“created_by_email”：“manager@yourcompany.com”，“语言”: [{“language_iso”：" fi "，“用户”: [{“user_id”：421.，“电子邮件”：“jdoe@mycompany.com”，“全名”：“John Doe”} ],“群体”: [{“ID”：191，“名称”：“语音邮件翻译”} ],“钥匙”:【11212，11241，11245]，“地位”：“创建”，“进步”：0，“initial_tm_leverage”:{“0% +”：91，“60% +”：0，“75% +”：0，"95%+"：0，“100%”：0},“keys_count”：3.，“words_count”：91，“completed_at”：无效的，“completed_at_timestamp”：无效的，“completed_by”：无效的，“completed_by_email”：无效的}，{“language_iso”：“汝”，“用户”: [{“user_id”：422.，“电子邮件”：“jfox@mycompany.com”，“全名”：“詹姆斯·福克斯”} ],“群体”: [{“ID”：191，“名称”：“语音邮件翻译”} ],“钥匙”:【11212，11241，11245]，“地位”：“进行中”，“进步”：90，“initial_tm_leverage”:{“0% +”：60，“60% +”：0，“75% +”：31，"95%+"：0，“100%”：0},“keys_count”：3.，“words_count”：91，“completed_at”：无效的，“completed_at_timestamp”：无效的，“completed_by”：无效的，“completed_by_email”：无效的} ],“source_language_iso”：“en”，“auto_close_languages”：符合事实的，“auto_close_task”：符合事实的，“auto_close_items”：符合事实的，“completed_at”：无效的，“completed_at_timestamp”：无效的，“completed_by”：无效的，“completed_by_email”：无效的，“自定义\u翻译\u状态\u ID”:【77，85，86]}}

更新任务

更新任务属性。需要管理任务管理权利。

属性

标题

字符串

任务标题。
描述

字符串

任务的简短描述。
due_date

字符串

到期日期在Y-m-d H:i:s格式。例如:“2018-12-24 23:59:59”
语言

对象

任务中的语言列表。
扩展属性密切属性
- language_iso
  
  字符串
  
  语言代码。
- 用户
  
  数组
  
  指定用于处理该语言的用户标识符列表。
- 组
  
  数组
  
  组标识符列表，分配用于处理语言。
- close_language
  
  布尔
  
  是否应关闭语言并发送通知。操作无法撤消。
auto_close_languages

布尔

在完成最后一项时，是否应该自动关闭语言。
auto_close_task

布尔

任务是否应该在所有语言完成时自动关闭。
auto_close_items

布尔

是否翻译任务项应在编辑时自动标记为已完成。
关闭任务

布尔

是否应该关闭任务并发送通知。任务不能再次重新启动。
closing_tags

数组

在关闭任务时将添加到受影响密钥的标记。
是否锁定翻译

布尔

如果设置为true，将锁定非分配项目成员的翻译。

定义

         把
         https://api.lokalise.com/api2/projects/{project_id:分支}/任务/{task_id}
        

示例请求体

｛“due_date”：“2019-12-31 12:00:00”，“auto_close_languages”：假，“auto_close_task”：假｝

示例请求

curl——request PUT \
——https url:/ / api.lokalise.com/api2/projects/ {project_id:分支}/ {task_id} \ /任务--标题“application / json内容类型:＼
--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”＼
——数据”{due_date”:“2019-12-31 12:00:00”、“auto_close_languages”:假的,“auto_close_task”:假}”

答复示例（200）

｛“项目id”：“20008339586 cded200e0d8.29879849”，“任务”:{“任务id”：55392，“标题”：“语音留言”，“描述”："需要你帮忙翻译一些语音信息。谢谢!”，“地位”：“进行中”，“进步”：40，“can_be_parent”：符合事实的，“task_type”：“翻译”，“parent_task_id”：12345，“closing_tags”:【“标记一”，“tag_two”]，“do_lock_translations”：假，“due_date”：“2019-12-31 12:00:00(等\ / UTC)”，“den_date_timestamp”：1546257600，“keys_count”：3.，“words_count”：91，“created_at”：“2018-12-31 12:00:00(等\ / UTC)”，“created_at_timestamp”：1546257600，“created_by”：420.，“created_by_email”：“manager@yourcompany.com”，“语言”: [{“language_iso”：" fi "，“用户”: [{“user_id”：421.，“电子邮件”：“jdoe@mycompany.com”，“全名”：“John Doe”} ],“群体”: [{“ID”：191，“名称”：“语音邮件翻译”} ],“钥匙”:【11212，11241，11245]，“地位”：“创建”，“进步”：0，“initial_tm_leverage”:{“0% +”：0，“60% +”：31，“75% +”：60，"95%+"：0，“100%”：0},“keys_count”：3.，“words_count”：91，“completed_at”：无效的，“completed_at_timestamp”：无效的，“completed_by”：无效的，“completed_by_email”：无效的}，{“language_iso”：“汝”，“用户”: [{“user_id”：422.，“电子邮件”：“jfox@mycompany.com”，“全名”：“詹姆斯·福克斯”} ],“群体”:[],“钥匙”:【11212，11241，11245]，“地位”：“进行中”，“进步”：90，“initial_tm_leverage”:{“0% +”：91，“60% +”：0，“75% +”：0，"95%+"：0，“100%”：0},“keys_count”：3.，“words_count”：91，“completed_at”：无效的，“completed_at_timestamp”：无效的，“completed_by”：无效的，“completed_by_email”：无效的} ],“source_language_iso”：“en”，“auto_close_languages”：假，“auto_close_task”：假，“completed_at”：无效的，“completed_at_timestamp”：无效的，“completed_by”：无效的，“completed_by_email”：无效的}}

删除一个任务

从项目中删除任务。需要管理任务管理权利。

定义

         删去
         https://api.lokalise.com/api2/projects/{project_id:分支}/任务/{task_id}
        

示例请求

curl——request DELETE \
——https url:/ / api.lokalise.com/api2/projects/ {project_id:分支}/ {task_id} \ /任务--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“task_deleted”：符合事实的｝

团队

团队的对象

属性

team_id.

数字

一个唯一的团队标识符。
的名字

字符串

团队的名字。
created_at.

字符串

创建团队的日期和时间。
created_at_timestamp

数字

创建团队时的Unix时间戳。
计划

字符串

团队目前的订阅计划。
quota_usage.

对象

当前计划配额使用情况。
扩展属性密切属性
- 用户
  
  数字
  
  允许进入团队的用户总数。
- 键
  
  数字
  
  所有团队项目的关键字总数。
- 项目
  
  数字
  
  团队中的项目总数。
- 茂
  
  数字
  
  月活跃用户总数(针对Lokalise SDK)。
quota_allowed

对象

当前计划津贴。
扩展属性密切属性
- 用户
  
  数字
  
  允许进入团队的用户总数。
- 键
  
  数字
  
  所有团队项目的关键字总数。
- 项目
  
  数字
  
  团队中的项目总数。
- 茂
  
  数字
  
  月活跃用户总数(针对Lokalise SDK)。

列出所有团队

列出用户可用的所有团队。

Url参数

限制

字符串

默认值：100

要包括的项目数量(最多5000)。
页面

字符串

默认值：1

返回从该页开始的结果。

定义

         得到
         https://api.lokalise.com/api2/teams
        

示例请求

curl——request GET \
——https url:/ / api.lokalise.com/api2/teams \--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

标题

X-Total-Count: 1

身体

｛“团队”: [{“team_id”：18821，“名称”：“MyCompany公司。”，“created_at”：“2018-12-31 12:00:00(等\ / UTC)”，“created_at_timestamp”：1546257600，“计划”：“必不可少”，“quota_usage”:{“用户”：14，“钥匙”：8125，“项目”：4，“猫”：119337},“quota_allowed”:{“用户”：40，“钥匙”：10000，“项目”：99999999，“猫”：200000年}}]}

团队用户

团队用户对象

属性

用户身份

数字

用户的唯一标识符。
电子邮件

字符串

用户的电子邮件。
fullname

字符串

用户名和姓氏。
created_at.

字符串

创建用户的日期/时间。
created_at_timestamp

数字

创建用户时的Unix时间戳。
角色

字符串

用户的角色。可用角色是老板，管理，成员．

列出所有团队用户

列出所有团队用户。需要管理在团队中的角色。

Url参数

限制

字符串

默认值：100

要包括的项目数量(最多5000)。
页面

字符串

默认值：1

返回从该页开始的结果。

定义

         得到
         https://api.lokalise.com/api2/teams/{team_id}/使用者
        

示例请求

curl——request GET \
——https url:/ / api.lokalise.com/api2/teams/ \ {team_id} /用户--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

标题

X-Total-Count: 2

身体

｛“team_id”：18821，“team_users”: [{“user_id”：420.，“电子邮件”：“jdoe@mycompany.com”，“全名”：“John Doe”，“created_at”：“2018-12-31 12:00:00(等\ / UTC)”，“created_at_timestamp”：1546257600，“角色”：“所有者”}，{“user_id”：421.，“电子邮件”：“axel@mycompany.com”，“全名”：“Axel福利”，“created_at”：“2018-12-31 12:00:00(等\ / UTC)”，“created_at_timestamp”：1546257600，“角色”：“成员”}]}

检索团队用户

检索团队用户对象。需要管理在团队中的角色。

定义

         得到
         https://api.lokalise.com/api2/teams/{team_id}/用户/{user_id}
        

示例请求

curl——request GET \
——https url://api.lokalise.com/api2/teams/{team_id}/users/{user_id}\--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

｛“team_id”：18821，“team_user”:{“user_id”：420.，“电子邮件”：“jdoe@mycompany.com”，“全名”：“John Doe”，“created_at”：“2018-12-31 12:00:00(等\ / UTC)”，“created_at_timestamp”：1546257600，“角色”：“所有者”}}

更新团队用户

更新团队用户的角色。需要管理在团队中的角色。

属性

角色

字符串

用户的角色。可用角色是老板，管理，成员．

定义

         把
         https://api.lokalise.com/api2/teams/{team_id}/用户/{user_id}
        

示例请求体

｛“角色”：“admin”｝

示例请求

curl——request PUT \
——https url://api.lokalise.com/api2/teams/{team_id}/users/{user_id}\--标题“application / json内容类型:＼
--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”＼
——数据”{“角色”:“admin”}’

答复示例（200）

｛“team_id”：18821，“team_user”:{“user_id”：421.，“电子邮件”：“axel@mycompany.com”，“全名”：“Axel福利”，“created_at”：“2018-12-31 12:00:00(等\ / UTC)”，“created_at_timestamp”：1546257600，“角色”：“admin”}}

删除团队用户

从团队中删除用户。需要管理在团队中的角色。

定义

         删去
         https://api.lokalise.com/api2/teams/{team_id}/用户/{user_id}
        

示例请求

curl——request DELETE \
——https url://api.lokalise.com/api2/teams/{team_id}/users/{user_id}\--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

｛“team_id”：18821，“team_user_deleted”：符合事实的｝

团队用户组

Team用户组对象

属性

group_id.

数字

组的唯一标识符。
的名字

字符串

组名。
权限

对象

组权限列表。
扩展属性密切属性
- is_admin
  
  布尔
  
  用户是否对项目具有Admin权限。
- 是你的审稿人吗
  
  布尔
  
  用户是否具有对项目的审阅权限。
- admin_rights
  
  数组
  
  组管理权限列表。
- 语言
  
  对象
  
  用户可访问的语言列表。
  扩展属性密切属性
  - lang_id
    
    数字
    
    语言ID。
  - lang_iso
    
    字符串
    
    语言代码。
  - 郎姓
    
    字符串
    
    语言的名字。
  - is_writable
    
    布尔
    
    用户是否对该语言有写访问权限。
created_at.

字符串

创建组的日期/时间。
created_at_timestamp

数字

创建组时的Unix时间戳。
team_id.

数字

团队标识符。
项目

数组

项目列表，组被添加到。
成员

数组

组成员列表(用户id)。

列出所有组

列出团队中的所有用户组。

Url参数

限制

字符串

默认值：100

要包括的项目数量(最多5000)。
页面

字符串

默认值：1

返回从该页开始的结果。

定义

         得到
         https://api.lokalise.com/api2/teams/{team_id}/团体
        

示例请求

curl——request GET \
-  url.'https://api.lokalise.com/api2/teams/ {team_id }/groups?limit= {limit} &page=（page}'＼
--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

标题

X-Total-Count：100

身体

｛“team_id”：444.，“user_groups”: [{“group_id”：50031，“名称”：“验证”，“权限”:【“is_admin”：假，“is_reviewer”：符合事实的，“语言”: [{“语言id”：640，“lang_iso”：“en”，“lang_name”：“英语”，“is_writable”：1}，{“语言id”：597，“lang_iso”：“汝”，“lang_name”：“俄罗斯”，“is_writable”：1} ],“admin_rights”: []],“created_at”：“2019-01-08 09:10:46(等/ UTC)”，“created_at_timestamp”：1546257600，“team_id”：444.，“项目”:【“598901215 bexxx43dcba74.xxx”]，“成员”:【22212[}]}

创建一个组

在团队中创建一个小组。需要管理就在队伍里。

如果is_admin标志设置为符合事实的，该组将自动访问所有项目语言，覆盖所提供的语言语言对象。

属性

的名字

字符串要求

组名。
是你的审稿人吗

布尔要求

组是否具有对项目的评审权限。
is_admin

布尔要求

组是否具有对项目的Admin访问权限。
admin_rights

数组

组管理权限列表。要求如果组具有admin权限。可能的值是上传，活动，下载，设置，create_branches.，统计数据，键，截图，术语表，贡献者，语言，任务．
语言

对象

要求如果组没有管理员权限。
扩展属性密切属性
- 参考
  
  数组
  
  组的引用语言id列表
- contributable
  
  数组
  
  组的可贡献语言id列表

定义

         帖子
         https://api.lokalise.com/api2/teams/{team_id}/团体
        

示例请求体

｛“名称”：“验证”，“is_reviewer”：符合事实的，“is_admin”：假，“admin_rights”:[],“语言”:{“参考”:[],“contributable”:【640]}}

示例请求

curl——请求发布\
——https url://api.lokalise.com/api2/teams/{team_id}/groups\--标题“application / json内容类型:＼
--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”＼
——数据{“名称”:“校对”、“is_reviewer”:真的,“is_admin”:假的,“admin_rights”:[],“语言”:{“参考”:[],“contributable”:[640]}}”

答复示例（200）

｛“team_id”：444.，“集团”:{“group_id”：50031，“名称”：“验证”，“权限”:{“is_admin”：假，“is_reviewer”：假，“admin_rights”:[],“语言”: [{“语言id”：640，“lang_iso”：“en”，“lang_name”：“英语”，“is_writable”：符合事实的}},“created_at”：“2019-01-08 09:10:46(等/ UTC)”，“created_at_timestamp”：1546257600，“team_id”：444.，“项目”:[],“成员”: []}}

检索一组

检索用户组对象。

定义

         得到
         https://api.lokalise.com/api2/teams/{team_id}/团体/{group_id}
        

示例请求

curl——request GET \
——https url:/ / api.lokalise.com/api2/teams/ {team_id} / {group_id} \ /组--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

｛“group_id”：50031，“名称”：“验证”，“权限”:{“is_admin”：假，“is_reviewer”：符合事实的，“admin_rights”:[],“语言”: [{“语言id”：640，“lang_iso”：“en”，“lang_name”：“英语”，“is_writable”：符合事实的}},“created_at”：“2019-01-08 09:15:28(等/ UTC)”，“created_at_timestamp”：1546257600，“team_id”：444.，“项目”:[],“成员”: []}

更新一个组

更新组的属性。需要管理就在队伍里。

属性

的名字

字符串要求

组名。
是你的审稿人吗

布尔要求

组是否拥有项目的审阅权限。
is_admin

布尔要求

组是否具有对项目的Admin访问权限。
admin_rights

数组

组管理权限列表。要求如果组具有admin权限。可能的值是上传，活动，下载，设置，create_branches.，统计数据，键，截图，术语表，贡献者，语言，任务．
语言

对象

要求如果组没有管理员权限。
扩展属性密切属性
- 参考
  
  数组
  
  组的引用语言id列表
- contributable
  
  数组
  
  组的可贡献语言id列表

定义

         把
         https://api.lokalise.com/api2/teams/{team_id}/团体/{group_id}
        

示例请求体

｛“名称”：“校对管理员”，“is_reviewer”：符合事实的，“is_admin”：符合事实的，“admin_rights”:【“上传”，“下载”，“任务”，“贡献者”，“截图”，“词汇表”，“钥匙”，“语言”，“设置”，“活动”，“统计”]，“语言”:{“参考”:[],“contributable”: []}}

示例请求

curl——request PUT \
——https url:/ / api.lokalise.com/api2/teams/ {team_id} / {group_id} \ /组--标题“application / json内容类型:＼
--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”＼
——数据{“名称”:“校对管理员”、“is_reviewer”:真的,“is_admin”:真的,“admin_rights”:[“上传”、“下载”、“任务”、“贡献者”、“截屏”、“术语表”,“钥匙”,“语言”、“设置”、“活动”,“统计”),“语言”:{“参考”:[],“contributable”:[]}}”

答复示例（200）

｛“team_id”：444.，“集团”:{“group_id”：50031，“名称”：“校对管理员”，“权限”:{“is_admin”：符合事实的，“is_reviewer”：符合事实的，“admin_rights”:【“上传”，“下载”，“任务”，“贡献者”，“截图”，“词汇表”，“钥匙”，“语言”，“设置”，“活动”，“统计”]，“语言”: [] },“created_at”：“2019-01-08 09:15:28(等/ UTC)”，“created_at_timestamp”：1546257600，“team_id”：444.，“项目”:[],“成员”: []}}

将项目添加到组

需要管理就在队伍里。

属性

项目

数组要求

要添加到组的项目ID列表。

定义

         把
         https://api.lokalise.com/api2/teams/{team_id}/团体/{group_id}/ /添加项目
        

示例请求体

｛“项目”:【“598901215 bexxx43dcba74.xxx”]}

示例请求

curl——request PUT \
——https url:/ / api.lokalise.com/api2/teams/ {team_id} /团体/ {group_id} /项目/添加\--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”＼
——数据'{“项目”：[“598901215BEXXX43DCBA74.xxx”]}'

答复示例（200）

｛“team_id”：444.，“集团”:{“group_id”：50031，“名称”：“校对管理员”，“权限”:{“is_admin”：符合事实的，“is_reviewer”：符合事实的，“admin_rights”:【“上传”，“下载”，“任务”，“贡献者”，“截图”，“词汇表”，“钥匙”，“语言”，“设置”，“活动”，“统计”]，“语言”: [] },“created_at”：“2019-01-07 14:21:44(等/ UTC)”，“created_at_timestamp”：1546257600，“team_id”：444.，“项目”:【“598901215 bexxx43dcba74.xxx”]，“成员”: []}}

从组中删除项目

需要管理就在队伍里。

属性

项目

数组要求

要从组中删除的项目ID列表。

定义

         把
         https://api.lokalise.com/api2/teams/{team_id}/团体/{group_id}/项目/删除
        

示例请求体

｛“项目”:【“598901215 bexxx43dcba74.xxx”]}

示例请求

curl——request PUT \
——https url:/ / api.lokalise.com/api2/teams/ {team_id} /团体/ {group_id} /项目/删除\--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”＼
——数据'{“项目”：[“598901215BEXXX43DCBA74.xxx”]}'

答复示例（200）

｛“team_id”：444.，“集团”:{“group_id”：50031，“名称”：“校对管理员”，“权限”:{“is_admin”：符合事实的，“is_reviewer”：符合事实的，“admin_rights”:【“上传”，“下载”，“任务”，“贡献者”，“截图”，“词汇表”，“钥匙”，“语言”，“设置”，“活动”，“统计”]，“语言”: [] },“created_at”：“2019-01-07 14:21:44(等/ UTC)”，“created_at_timestamp”：1546257600，“team_id”：444.，“项目”:[],“成员”: []}}

向组中添加成员

需要管理就在队伍里。

属性

用户

数组要求

要添加到组的用户id列表。

定义

         把
         https://api.lokalise.com/api2/teams/{team_id}/团体/{group_id}/ /成员添加
        

示例请求体

｛“用户”:【22212]}

示例请求

curl——request PUT \
——https url:/ / api.lokalise.com/api2/teams/ {team_id} /团体/ {group_id} / /添加\成员--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”＼
——数据”{“用户”:[22212]}’

答复示例（200）

｛“team_id”：444.，“集团”:{“group_id”：50031，“名称”：“校对管理员”，“权限”:{“is_admin”：符合事实的，“is_reviewer”：符合事实的，“admin_rights”:【“上传”，“下载”，“任务”，“贡献者”，“截图”，“词汇表”，“钥匙”，“语言”，“设置”，“活动”，“统计”]，“语言”: [] },“created_at”：“2019-01-07 14:21:44(等/ UTC)”，“created_at_timestamp”：1546257600，“team_id”：444.，“项目”:[],“成员”:【22212]}}

从组中删除成员

需要管理就在队伍里。

属性

用户

数组要求

从组中删除的用户ID列表。

定义

         把
         https://api.lokalise.com/api2/teams/{team_id}/团体/{group_id}/成员/删除
        

示例请求体

｛“用户”:【22212]}

示例请求

curl——request PUT \
——https url://api.lokalise.com/api2/teams/ {team_id} / groups/--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”＼
——数据”{“用户”:[22212]}’

答复示例（200）

｛“team_id”：444.，“集团”:{“group_id”：50031，“名称”：“校对管理员”，“权限”:{“is_admin”：符合事实的，“is_reviewer”：符合事实的，“admin_rights”:【“上传”，“下载”，“任务”，“贡献者”，“截图”，“词汇表”，“钥匙”，“语言”，“设置”，“活动”，“统计”]，“语言”: [] },“created_at”：“2019-01-07 14:21:44(等/ UTC)”，“created_at_timestamp”：1546257600，“team_id”：444.，“项目”:[],“成员”: []}}

删除一组

从小组中删除一个组。需要管理就在队伍里。

定义

         删去
         https://api.lokalise.com/api2/teams/{team_id}/团体/{group_id}
        

示例请求

curl——request DELETE \
——https url:/ / api.lokalise.com/api2/teams/ {team_id} / {group_id} \ /组--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

｛“team_id”：444.，“group_deleted”：符合事实的｝

翻译

翻译的对象

属性

translation_id

数字

独特的翻译标识符。
密钥id

数字

转换键的标识符。
language_iso

字符串

语言代码。
修改的

字符串

最后一次翻译修改的日期和时间。
modified_at_timestamp.

数字

上次翻译修改的Unix时间戳。
修改

数字

最后进行修改的用户的标识符。
modified_by_email

字符串

最后一次修改的用户的电子邮件。
翻译

字符串

实际翻译内容。Pass作为一个对象，以防它包含复数形式和is_plural是符合事实的．
is_unverified

布尔

是否启用未验证标志。
你被审查了吗

布尔

是否启用了“已评审”标志。
reviewed_by

数字

已审阅过翻译的用户标识符(如果审阅过)。
单词

数字

翻译的字数。
自定义\u翻译\u状态

数组

组成的数组自定义翻译状态对象。
任务id

数字

任务的标识符，如果密钥是一个的一部分，或无效的如果不是。

列出所有翻译

检索未分组的项目翻译项列表。

您可能想要请求键资源以获取所有语言的结构化键/翻译对。

Url参数

disable_references

字符串

默认值：0

是否禁用键引用。可能的值是1和0．
filter_lang_id

字符串

仅为显示的语言ID返回翻译。
filter_is_reviewed.

字符串

默认值：0

过滤被审查的翻译。可能的值是1和0．
filter_unverified

字符串

默认值：0

过滤未经验证的翻译。可能的值是1和0．
filter_untranslated

字符串

默认值：0

通过未翻译的键进行过滤。可能的值是1和0．
filter_qa_issues

字符串

一个或多个QA问题要过滤(逗号分隔)。可能的值是spelling_and_grammar，占位符，超文本标记语言，url_count，网址，Email_Count.，电子邮件，括号，数字，leading_whitespace，trailing_whitespace，double_space，Special_PlaceHolder.和Unbalanced_Brackets.．
filter_active_task_id

字符串

过滤属于给定任务ID的翻译。
限制

字符串

默认值：100

要包括的项目数量(最多5000)。
页面

字符串

默认值：1

返回从该页开始的结果。

定义

         得到
         https://api.lokalise.com/api2/projects/{project_id:分支}/翻译
        

示例请求

curl——request GET \
——https url://api.lokalise.com/api2/projects/ {project_id：branch }/translations \--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

标题

X-Total-Count: 331

身体

｛“项目id”：“20008339586 cded200e0d8.29879849”，“翻译”: [{“translation_id”：344412，“key_id”：553662，“language_iso”：“恩，我们”，“modified_at”：“2018-12-31 12:00:00(等\ / UTC)”，“modified_at_timestamp”：1546257600，“modified_by”：420.，“modified_by_email”：“user@mycompany.com”，“翻译”：“你好,世界!”，“is_unverified”：符合事实的，“是否已审核”：假，“reviewed_by”：0，“文字”：2，“custom_translation_statuses”: [{“ID”：124，“标题”：“默认状态”，“颜色”：“#ffffff”} ],“任务id”：1182}, ... {“translation_id”：344417，“key_id”：553662，“language_iso”：“汝”，“modified_at”：“2018-12-31 12:00:00(等\ / UTC)”，“modified_at_timestamp”：1546257600，“modified_by”：420.，“modified_by_email”：“user@mycompany.com”，“翻译”：“Привет,мир!”，“is_unverified”：假，“是否已审核”：假，“reviewed_by”：0，“文字”：2，“custom_translation_statuses”:[],“任务id”：无效的}]}

检索一个翻译

检索翻译对象。

Url参数

disable_references

字符串

默认值：0

是否禁用键引用。可能的值是1和0．

定义

         得到
         https://api.lokalise.com/api2/projects/{project_id:分支}/翻译/{translation_id}
        

示例请求

curl——request GET \
——https url://api.lokalise.com/api2/projects/{project_id:branch}/translations/{translation_id}\--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“翻译”:{“translation_id”：344412，“key_id”：553662，“language_iso”：“恩，我们”，“modified_at”：“2018-12-31 12:00:00(等\ / UTC)”，“modified_at_timestamp”：1546257600，“modified_by”：420.，“modified_by_email”：“user@mycompany.com”，“翻译”：“你好,世界!”，“is_unverified”：符合事实的，“是否已审核”：假，“reviewed_by”：0，“文字”：2，“custom_translation_statuses”:[],“任务id”：无效的}}

更新一个翻译

更新一个翻译。另外,使用批量密钥更新端点来更新翻译。

属性

翻译

字符串要求

实际翻译内容。对多个键使用JSON对象。
is_unverified

布尔

是否启用未验证标志。
你被审查了吗

布尔

是否启用了“已评审”标志。
custom_translation_status_ids

数组

将分配给转换的自定义转换状态ID（现有状态将被替换）。

定义

         把
         https://api.lokalise.com/api2/projects/{project_id:分支}/翻译/{translation_id}
        

示例请求体

｛“翻译”：“敏捷的棕色狐狸跳过了懒狗。”，“is_unverified”：假，“是否已审核”：符合事实的｝

示例请求

curl——request PUT \
——https url://api.lokalise.com/api2/projects/{project_id:branch}/translations/{translation_id}\--标题“application / json内容类型:＼
--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”＼
——数据'{"translation":"Quick brown fox jumps over the lazy dog."，"is_unverified":false，" is_reviewing ":true}' "

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“翻译”:{“translation_id”：344412，“key_id”：553662，“language_iso”：“恩，我们”，“modified_at”：“2018-12-31 12:00:00(等\ / UTC)”，“modified_at_timestamp”：1546257600，“modified_by”：420.，“modified_by_email”：“user@mycompany.com”，“翻译”：“敏捷的棕色狐狸跳过了懒狗。”，“is_unverified”：假，“是否已审核”：符合事实的，“reviewed_by”：1357，“文字”：8，“custom_translation_statuses”:[],“任务id”：无效的}}

翻译供应商

翻译提供者用于订单．

Translation提供程序对象

属性

provider_id

数字

提供程序的唯一标识符。
的名字

数字

提供者的名称。
鼻涕虫

字符串

SLUID提供商。
price_pair_min

数字

每对语言的最低总价。如果没有最低要求，则为0.00。
网站地址

字符串

提供商网站。
描述

字符串

提供者描述。
层

对象

可用翻译层。
扩展属性密切属性
- tier_id
  
  数字
  
  层的标识符。
- 的名字
  
  字符串
  
  分级名称。
对

对象

语言成对和价格列表。
扩展属性密切属性
- tier_id
  
  数字
  
  翻译层。
- from_lang_iso
  
  字符串
  
  源语言标识符。
- from_lang_name.
  
  字符串
  
  源语言的名字。
- to_lang_iso
  
  字符串
  
  目标语言标识符。
- to_lang_name
  
  字符串
  
  目标语言名称。
- price_per_word
  
  数字
  
  价格每字美元。

列出所有供应商

列出所有翻译提供商。

Url参数

限制

字符串

默认值：100

要包括的项目数量(最多5000)。
页面

字符串

默认值：1

返回从该页开始的结果。

定义

         得到
         https://api.lokalise.com/api2/teams/{team_id}/翻译_Providers.
        

示例请求

curl——request GET \
——https url:/ / api.lokalise.com/api2/teams/ {team_id} / translation_providers \--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

标题

X-Total-Count: 4

身体

｛“translation_providers”: [{“provider_id”：1，“名称”：“Gengo”，“鼻涕虫”：“gengo”，“price_pair_min”：“0.00”，“website_url”：“https://gengo.com”，“描述”：“在Gengo，我们的使命是为每个人提供语言服务，连接全球社区。我们的1.8万多名翻译经过测试，符合严格的项目标准。翻译人员分布在世界各地和每个时区，这使我们能够支持超过35种语言，并朝着Gengo的使命努力。”,},…]}

检索一个提供者

检索翻译服务提供商具有层和可用语言对的对象。

定义

         得到
         https://api.lokalise.com/api2/teams/{team_id}/翻译_Providers /{provider_id}
        

示例请求

curl——request GET \
——https url:/ / api.lokalise.com/api2/teams/ {team_id} / translation_providers / {provider_id} \--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

｛“provider_id”：1，“名称”：“Gengo”，“鼻涕虫”：“gengo”，“price_pair_min”：“0.00”，“website_url”：“https://gengo.com”，“描述”：“在Gengo，我们的使命是为每个人提供语言服务，连接全球社区。我们的1.8万多名翻译经过测试，符合严格的项目标准。翻译人员分布在世界各地和每个时区，这使我们能够支持超过35种语言，并朝着Gengo的使命努力。”，“层”: [{“tier_id”：1，“标题”：“母语人士”}，{“tier_id”：2，“标题”：“专业翻译”} ],“对”: [{“tier_id”：1，“from_lang_iso”：“恩，我们”，“from_lang_name”：“英语(美国)”，“到_lang_iso”：“汝”，“给你的名字”：“俄罗斯”，“每字价格”：“0.07”},……]}

翻译状态

自定义翻译状态用于提供更有效的翻译工作流。了解更多．

翻译状态对象

属性

status_id

数字

唯一的自定义翻译状态标识符。
标题

字符串

地位头衔。
颜色

字符串

状态的十六进制颜色。

列出所有状态

列出项目中的所有自定义翻译状态。

Url参数

限制

字符串

默认值：100

要包括的项目数量(最多5000)。
页面

字符串

默认值：1

返回从该页开始的结果。

定义

         得到
         https://api.lokalise.com/api2/projects/{project_id:分支}/ custom_translation_statuses
        

示例请求

curl——request GET \
——https url:/ / api.lokalise.com/api2/projects/ {project_id:分支}/ custom_translation_statuses \--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

标题

X-Total-Count: 1

身体

｛“项目id”：“20008339586 cded200e0d8.29879849”，“custom_translation_statuses”: [{“状态\u id”：123，“标题”：“默认状态”，“颜色”：“#ffffff”}]}

创建一个状态

在项目中创建自定义翻译状态。

属性

标题

字符串要求

地位头衔。
颜色

字符串要求

状态的十六进制颜色。

定义

         帖子
         https://api.lokalise.com/api2/projects/{project_id:分支}/ custom_translation_statuses
        

示例请求体

｛“标题”：“看过的医生”，“颜色”：“# ff9f1a”｝

示例请求

curl——请求发布\
——https url:/ / api.lokalise.com/api2/projects/ {project_id:分支}/ custom_translation_statuses \--标题“application / json内容类型:＼
--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”＼
——数据“{”称号”:“看过的医生”,“色”:“# ff9f1a”}”

答复示例（200）

｛“项目id”：“20008339586 cded200e0d8.29879849”，“自定义\u翻译\u状态”:{“状态\u id”：124，“标题”：“看过的医生”，“颜色”：“# ff9f1a”}}

检索一个状态

检索自定义翻译状态对象。

定义

         得到
         https://api.lokalise.com/api2/projects/{project_id:分支}/ custom_translation_statuses /{status_id}
        

示例请求

curl——request GET \
——https url://api.lokalise.com/api2/projects/{project\u id:branch}/custom\u translation\u status/{status\u id}\--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

｛“项目id”：“20008339586 cded200e0d8.29879849”，“自定义\u翻译\u状态”:{“状态\u id”：124，“标题”：“看过的医生”，“颜色”：“# ff9f1a”}}

更新状态

更新自定义翻译状态。

属性

标题

字符串

地位头衔。
颜色

字符串

状态的十六进制颜色。

定义

         把
         https://api.lokalise.com/api2/projects/{project_id:分支}/ custom_translation_statuses /{status_id}
        

示例请求体

｛“标题”：“由工作人员审查”｝

示例请求

curl——request PUT \
——https url://api.lokalise.com/api2/projects/{project\u id:branch}/custom\u translation\u status/{status\u id}\--标题“application / json内容类型:＼
--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”＼
——数据{“标题”:“回顾员工“}”

答复示例（200）

｛“项目id”：“20008339586 cded200e0d8.29879849”，“自定义\u翻译\u状态”:{“状态\u id”：124，“标题”：“由工作人员审查”，“颜色”：“# ff9f1a”}}

删除一个状态

删除aa自定义翻译状态。

定义

         删去
         https://api.lokalise.com/api2/projects/{project_id:分支}/ custom_translation_statuses /{status_id}
        

示例请求

curl——request DELETE \
——https url://api.lokalise.com/api2/projects/{project\u id:branch}/custom\u translation\u status/{status\u id}\--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“删除”：符合事实的｝

获取可用的颜色

检索可分配给自定义翻译状态的可用颜色数组。

定义

         得到
         https://api.lokalise.com/api2/projects/{project_id:分支}/ custom_translation_statuses / colors
        

示例请求

curl——request GET \
——https url://api.lokalise.com/api2/projects/{project\u id:branch}/custom\u translation\u status/colors\--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

｛“颜色”:【“# 61 bd4f”，“# f2d600”，“# ff9f1a”，“# eb5a46”，“# c377e0”，“＃0079BF”，“# 00 c2e0”，“344563 #”，“# ff78cb”]}

网钩

Webhook对象

属性

webhook_id

数字

webhook的唯一标识符。
网址

字符串

指定的URL。
分支

字符串

如果webhook被限制为单个分支。
秘密

字符串

X-Secret与webhook请求一起发送的头信息。
事件

数组

webhook订阅的事件列表。
event_lang_map

对象

地图列表与语言分配的事件。
扩展属性密切属性
- 事件
  
  字符串
  
  事件名称。
- lang_iso_代码
  
  数组
  
  iso代码的语言列表。

列出所有人

检索已配置的webhooks列表。需要管理设置管理权利。

Url参数

限制

字符串

默认值：100

要包括的项目数量(最多5000)。
页面

字符串

默认值：1

返回从该页开始的结果。

定义

         得到
         https://api.lokalise.com/api2/projects/{project_id}/人
        

示例请求

curl——request GET \
——https url:/ / api.lokalise.com/api2/projects/ {project_id} /人\--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

标题

X-Total-Count: 2

身体

｛“项目id”：“20008339586 cded200e0d8.29879849”，“Webhooks”: [{“webhook_id”：“cb755f36c1a5ec7063cf6dedf056eb5a730e033d”，“url”：“https:\/\/my.domain.com\/webhook”，“分支”：无效的，“秘密”：“CCBE0D72A8377B2C91DB25D628192EADE03158C”，“事件”:【“Project.Imported”，“project.languages.added”，“project.language.removed”，“project.key.added”，“project.keys.deleted”，“project.key.modified”，“project.translation.updated”]，“event_lang_map”: [{“事件”：“project.translation.updated”，“lang_iso_codes”:【“en_gb”{}}， {“webhook_id”：“b9069a53700dd7d1fdbaa7dd96c4d6ad25a0e465”，“url”：“https:\/\/my.domain.com\/webhook”，“分支”：无效的，“秘密”：“CCBE0D72A8377B2C91DB25D628192EADE03158C”，“事件”:【“project.translation.proofread”]，“event_lang_map”: [{“事件”：“project.translation.proofread”，“lang_iso_codes”:【“en”，“en_gb”[}]}]}

检索webhook

检索Webhook对象。需要管理设置管理权利。

定义

         得到
         https://api.lokalise.com/api2/projects/{project_id}/网钩/{webhook_id}
        

示例请求

curl——request GET \
——https url://api.lokalise.com/api2/projects/{project_id}/webhooks/{webhook_id}\--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

｛“项目id”：“600904245C4ECF0EC4A9D4.28360690”，“webhook”:{“webhook_id”：“cb755f36c1a5ec7063cf6dedf056eb5a730e033d”，“url”：“https:\/\/my.domain.com\/webhook”，“分支”：无效的，“秘密”：“CCBE0D72A8377B2C91DB25D628192EADE03158C”，“事件”:【“Project.Imported”，“project.languages.added”，“project.language.removed”，“project.key.added”，“project.keys.deleted”，“project.key.modified”，“project.translation.updated”]，“event_lang_map”: [{“事件”：“project.translation.updated”，“lang_iso_codes”:【“en_gb”[}]}}

创建一个webhook

在项目中创建一个Webhook。需要管理设置管理权利。看到我们的文档查看可用事件和有效负载示例。

属性

网址

字符串要求

指定端点的URL。
分支

字符串

您可以通过将分支的名称指定为字符串来将Webhook的用法限制为特定分支。如果你通过了无效的或者跳过此属性，webhook将应用于所有分支。
事件

数组要求

要订阅的事件列表。可能的值是project.imported，project.exported，project.deleted，project.snapshot，project.languages.added，project.language.project已删除，project.language.settings\u已更改，project.key.added，project.key.modified，project.keys.deleted，project.key.comment.added，project.translation.updated，project.translation.proofread，project.contributor.added，project.contributor.deleted，project.task.created，project.task.closed，project.task.deleted，project.task.language.closed，project.branch.added，project.branch.deleted，project.branch.merged，team.order.created，team.order.completed，team.order.deleted．
event_lang_map

对象

映射事件与一组语言的iso代码。对于项目中的所有语言，忽略此参数。目前只project.translation.updated和project.translation.proofread事件可以用语言进行映射。
扩展属性密切属性
- 事件
  
  字符串
  
  事件名称。
- lang_iso_代码
  
  数组
  
  iso代码的语言列表。

定义

         帖子
         https://api.lokalise.com/api2/projects/{project_id}/人
        

示例请求体

｛“url”：“https://my.domain.com/webhook”，“事件”:【“project.translation.proofread”，“project.translation.updated”]，“event_lang_map”: [{“事件”：“project.translation.updated”，“lang_iso_codes”:【“en_gb”[}]}

示例请求

curl——请求发布\
——https url:/ / api.lokalise.com/api2/projects/ {project_id} /人\--标题“application / json内容类型:＼
--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”＼
——数据{“url”:“https://my.domain.com/webhook”,“事件”:“project.translation.proofread”、“project.translation.updated”,“event_lang_map”:[{“事件”:“project.translation.updated”、“lang_iso_codes”:[" en_GB "]}]}”

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“webhook”:{“webhook_id”：“138 c1ffa0ad94848f01f980e7f2f2af19d1bd553”，“url”：“https:\/\/my.domain.com\/webhook”，“分支”：无效的，“秘密”：“CCBE0D72A8377B2C91DB25D628192EADE03158C”，“事件”:【“project.translation.proofread”，“project.translation.updated”]，“event_lang_map”: [{“事件”：“project.translation.proofread”，“lang_iso_codes”:【“en”，“en_gb”，“罗斯”}, {“事件”：“project.translation.updated”，“lang_iso_codes”:【“en_gb”[}]}}

更新一个webhook

更新项目中已配置的webhook。需要管理设置管理权利。

属性

网址

字符串

将URL更新到您的端点。
分支

字符串

您可以通过将分支的名称指定为字符串来将Webhook的用法限制为特定分支。如果你通过了无效的或者跳过此属性，webhook将应用于所有分支。
事件

数组

替换事件列表。看到我们的文档查看可用事件和有效负载示例。
event_lang_map

对象

映射事件与一组语言的iso代码。对于项目中的所有语言，忽略此参数。目前只project.translation.updated和project.translation.proofread事件可以用语言进行映射。
扩展属性密切属性
- 事件
  
  字符串
  
  事件名称。
- lang_iso_代码
  
  数组
  
  iso代码的语言列表。

定义

         把
         https://api.lokalise.com/api2/projects/{project_id}/网钩/{webhook_id}
        

示例请求体

｛“事件”:【“project.translation.proofread”，“project.translation.updated”，“Project.Imported”]，“event_lang_map”: [{“事件”：“project.translation.proofread”，“lang_iso_codes”:【“en_gb”}, {“事件”：“project.translation.updated”，“lang_iso_codes”:【“en_gb”[}]}

示例请求

curl——request PUT \
——https url://api.lokalise.com/api2/projects/{project_id}/webhooks/{webhook_id}\--标题“application / json内容类型:＼
--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”＼
——数据{”事件”:[“project.translation.proofread”、“project.translation.updated”,“project.imported”),“event_lang_map”:[{“事件”:“project.translation.proofread”、“lang_iso_codes”:[" en_GB "]},{“事件”:“project.translation.updated”、“lang_iso_codes”:[" en_GB "]}]}”

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“webhook”:{“webhook_id”：“138 c1ffa0ad94848f01f980e7f2f2af19d1bd553”，“url”：“https:\/\/my.domain.com\/webhook”，“分支”：无效的，“秘密”：“CCBE0D72A8377B2C91DB25D628192EADE03158C”，“事件”:【“project.translation.proofread”，“project.translation.updated”，“Project.Imported”]，“event_lang_map”: [{“事件”：“project.translation.proofread”，“lang_iso_codes”:【“en_gb”}, {“事件”：“project.translation.updated”，“lang_iso_codes”:【“en_gb”[}]}}

删除一个webhook

删除项目中已配置的webhook。需要管理设置管理权利。

定义

         删去
         https://api.lokalise.com/api2/projects/{project_id}/网钩/{webhook_id}
        

示例请求

curl——request DELETE \
——https url:/ / api.lokalise.com/api2/projects/ {project_id} /人/ {webhook_id}

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“webhook_deleted”：符合事实的｝

再生一个webhook秘密

再生一个webhook秘密。需要管理设置管理权利。

定义

         补丁
         https://api.lokalise.com/api2/projects/{project_id}/网钩/{webhook_id}/秘密/再生
        

示例请求

卷曲 -  request补丁\
——https url:/ / api.lokalise.com/api2/projects/ {project_id} /人/ {webhook_id} /机密/再生\--标题“x-api-token: f4d3f29bf893dc3583e9970735e08de094e82b0”

答复示例（200）

｛“项目id”：“3002780358964 f9bab5a92.87762498”，“秘密”：“CCBE0D72A8377B2C91DB25D628192EADE03158C”｝

复数和占位符

在大多数情况下，我们将正确地将复数和占位符导出为您选择的文件格式，但是可以覆盖默认值通用占位符转换行为和多种格式导出选项。使用下表指定导出参数。

文件格式	兼容的复数形式	兼容的占位符格式
`android_sdk`	`通用的`	`printf`
`ios_sdk`	`通用的`	`ios`
`xml`	`通用的`	`printf`
`字符串`	`通用的`	`ios`
`csv`	`json_string,加护病房`	`Printf ios icu net i18n raw`
`xlsx`	`json_string,加护病房`	`Printf ios icu net i18n raw`
`阿宝`	`通用的`	`Printf，ICU，RAW`
`性质`	`json_string,加护病房`	`printf,加护病房`
`json`	`json_string，ICU，Symfony，Array，I18Next`	`Printf, ios, icu, net, symfony, i18n, raw`
`xliff`	`通用的,json_string, icu`	`Printf ios icu raw`
`普利斯特`	`json_string,加护病房`	`printf, ios, icu`
`Resx.`	`json_string,加护病房`	`网`
`js`	`json_string，ICU，Symfony，Array，I18Next`	`Printf, icu, symfony, i18n, raw`
`react_native`	`json_string、icu、数组`	`Printf ios icu i18n raw`
`symfony_xliff`	`json_string icu, symfony`	`Printf, icu, symfony, raw`
`xlf`	`json_string,加护病房`	`Printf，ICU，RAW`
`php`	`Json_string, icu, symfony，数组`	`Printf, icu, symfony, i18n, raw`
`ini`	`json_string,加护病房`	`printf,加护病房`
`ruby_yaml`	`json_string、icu、数组`	`printf,加护病房`
`yaml`	`Json_string, icu, symfony，数组`	`Printf, icu, symfony, i18n, raw`
`月31`	`json_string,加护病房`	`printf,加护病房`
`ts`	`通用的`	`printf,加护病房`
`arb`	`加护病房`	`加护病房`

复数格式描述

`通用的`	选定文件格式的通用复数实现
`json_string`	{"one":" one user online"，"other":"%s users online"}
`加护病房`	{index.hero.title，复数，一个{一个在线用户}其他{%s在线用户}
`数组`	返回一个数组(如果格式适用)
`i18next`	{“key”：“一个苹果”，“key_plural”：“许多苹果”}
`symfony`	一个苹果\|许多苹果

占位符的格式描述

示例字符串:我的名字是[%s:name]。我有[%。2f] dollars.

`printf`	Printf风格占位符 -“我的名字是%s。我有%.2f美元。”。
`ios`	iOS-style占位符-“我的名字是%@。我有%。2f dollars."
`加护病房`	ICU消息格式占位符-“我的名字是{name}。我有{0}美元。”
`网`	.NET占位符格式“我的名字是{0}。我有{0:0.00}美元。”
`symfony`	Symfony占位符格式 -“我的名字是%name%。我有%placeholder_1%美元。”
`i18n`	I18N占位符格式 -“我的名字是{name}}。我有{{0}}。”
`生`	不进行处理。

文件格式

文件格式	名称
`android_sdk`	本地化Android SDK包
`ios_sdk`	lockalise iOS SDK包
`xml`	安卓资源
`字符串`	苹果的字符串
`csv`	逗号分隔值
`xlsx`	Excel 2007
`阿宝`	Gettext
`性质`	Java属性
`json`	JSON平和JSON嵌套
`json_结构`	结构化的JSON
`xliff`	苹果XLIFF
`普利斯特`	objective - c /可可属性
`Resx.`	.NET资源
`js`	JavaScript对象
`react_native`	反应本机（I18n库）
`symfony_xliff`	PHP XLIFF交响曲
`xlf`	Anglular i18n XLIFF
`php_array`	PHP数组
`php_laravel`	拉威尔酒店
`ini`	PHP INI
`ruby_yaml`	Ruby YAML
`yaml`	YAML
`月31`	Salesforce翻译
`ts`	Qt语言学家
`多克斯`	Docx
`超文本标记语言`	超文本标记语言
`arb`	ARB

错误

Lokalise使用传统的HTTP响应代码来指示API请求的成功或失败。一般来说:代码在2 xx范围显示成功。码的3xx表明重定向。码的4 xxRange表示在给定的信息下失败的错误(例如，省略了一个必需的参数，一个电荷失败，等等)。码的5xxrange表示本地化服务器出现错误(这种情况很少见)。

代码	原因
200年好	一切正常工作。
208 -已报告	已添加已发布的资源。
400 -错误请求	该请求是不可接受的，通常是由于缺少所需参数。
401 -未经授权	没有提供有效的API密钥。
403年被禁止的	未授予身份验证用户执行请求操作的权限。
404 -未找到	请求的资源不存在。
406 -不接受	发布的资源是畸形的或损坏的。
409-冲突	请求与另一个请求冲突(可能由于使用相同的幂等键)。
423锁定	所提供的令牌目前用于处理另一个请求。我们不支持并发请求。
429 -太多的请求	太多的请求过快地击中了API。我们建议对你的要求作出指数级的让步。
500,502, 503, 504 -服务器错误	本地化端出了问题。(这些都是罕见的。)

错误的对象

属性

代码

数字

错误代码。
信息

字符串

自定义错误消息提供其他信息。

变化

2021-09-08

贡献者:添加任务（布尔值）到可能的值列表贡献者admin_rights属性。
团队用户组:添加任务（布尔值）到可能的值列表团队用户组admin_rights属性。

2021-08-02

全球我们要介绍一下利率限制API终结点将于2021年9月14日公布。

2021-05-24

贡献者:添加术语表（布尔值）到可能的值列表贡献者admin_rights属性。

2021-03-03

翻译:添加任务id属性。
翻译:添加filter_active_task_id(数量)参数列出所有翻译端点。过滤属于给定任务ID的翻译。
贡献者:添加create_branches.（布尔值）到可能的值列表贡献者admin_rights属性。
团队用户组:添加create_branches.的可能值列表团队用户组权限{admin_rights}属性。

2021-02-24

订单:添加付款方法(字符串)参数订单端点。
订单:添加付款方法到创建订单属性列表。

2021-02-10

全球：弃用使用模糊在所有端点(用未经证实的）.

2021-02-04

任务:添加处理价值可能订单状态值列表。

2021-02-01

任务:添加auto_close_items到任务属性列表。
任务:添加auto_close_items（布尔）参数到创建任务端点。
任务:添加auto_close_items（布尔）参数到更新任务端点。

2020-11-24

排队过程:添加的分页参数排队过程端点列表。

2020-10-01

任务:添加源代码\u语言\u iso(字符串)参数创建任务端点。
任务:添加源代码\u语言\u iso到任务属性列表。

2020-07-27

文件夹:添加php_array和php_laravel格式格式参数下载文件端点。格式php仍然可以向后兼容。

2020-07-20

项目对象:添加自定义\u翻译\u状态（布尔）和custom_translation_statuses_allow_multiple(布尔)字段设置属性列表。

2020-07-14

订单:增加对谷歌和DeepL机器翻译引擎的支持。
供应商:将谷歌和DeepL机器翻译引擎添加到可用的提供商。

2020-07-01

文件夹:删除队列参数的上传一个文件端点。
文件夹:强制所有上传在上传一个文件端点。请迁移您的代码以支持新的202和302响应代码。

2020-05-13

键:添加translations_modified_at和translations_modified_at_timestamp.属性来键资源。
键:添加修改的和modified_at_timestamp.属性来键资源。

2020-05-09

文件夹:添加队列参数上传一个文件端点。
排队过程:添加排队过程资源和端点。

2020-05-08

文件夹:添加skip_detect_lang_iso参数上传一个文件端点。

2020-04-03

分支机构:添加target_branch_id参数合并一个分支端点。
分支机构:改变强制\u冲突\u解决\u使用参数合并一个分支端点接受新源和目标值。旧值主人和分支在不使用new的情况下仍然接受向后兼容吗target_branch_id参数。

2020-03-05

文件夹:添加custom_translation_status_ids参数上传一个文件端点。
文件夹：添加custom_translation_status_inserted_keys(保龄球)参数上传一个文件端点。添加插入键的指定状态。
文件夹：添加自定义\翻译\状态\更新\密钥(保龄球)参数上传一个文件端点。向更新的键添加指定的状态。
文件夹：添加自定义\u翻译\u状态\u跳过\u键(保龄球)参数上传一个文件终点。将指定状态添加到跳过的键。
键：添加custom_translation_status_ids(字符串)参数创建密钥端点。
键：添加custom_translation_status_ids(字符串)参数批量更新端点。
键：添加merge_custom_translation_statuses(字符串)参数批量更新端点。

2020-02-25

网钩:添加再生一个webhook秘密端点

2020-02-03

键：添加filter_archived(字符串)参数列出所有密钥端点。

2019-11-04

分支机构:添加合并一个分支端点

2019-10-15

文件夹:添加filter_untranslated参数列出所有翻译
文件夹:添加filter_statuses参数列出所有任务

2019-10-11

分支机构:添加分支机构资源和端点。
全球:更新端点以支持分支。

2019-07-08

文件夹:添加add_newline_eof参数下载文件端点。

2019-06-03

文件夹:添加custom_translation_status_ids参数下载文件端点。

2019-05-10

自定义翻译状态:添加自定义翻译状态资源和端点。
翻译:添加自定义\u翻译\u状态属性。
任务:添加custom_translation_status_ids属性。

2019-04-14

全球:增加了unix时间戳属性(created_at_timestamp，modified_at_timestamp.等等)。
项目对象:添加base_language_id(数值)属性。
项目对象:添加base_language_iso(字符串)属性。
翻译:添加filter_fuzzy(字符串)参数列出所有翻译端点。未验证的过滤器翻译（模糊）。可能的值是1和0．

2019-04-04

文件夹：添加bundle_description(字符串)参数下载文件端点。

2019-03-07

项目：添加语言(数组)的参数创建一个项目端点。一个或多个要添加的项目语言。
项目：添加base_lang_iso.(字符串)参数创建一个项目端点。默认(基础)项目语言的语言/地区代码。
项目：添加project_type(字符串)参数创建一个项目端点。选择项目类型。
键：添加filter_untranslated(数量)参数列出所有密钥端点。通过未翻译的键进行过滤。可能的值是1和0．
键：添加filter_translation_lang_ids(字符串)参数列出所有密钥端点。一个或多个要过滤的语言ID(用逗号分隔)。将只包括列出的id的翻译。
文件夹：添加tag_inserted_keys(保龄球)参数上传一个文件端点。为插入的键添加指定的标记。
文件夹：添加tag_updated_keys(保龄球)参数上传一个文件端点。将指定的标记添加到更新的密钥。
文件夹：添加tag_skipped_keys(保龄球)参数上传一个文件端点。为跳过的键添加指定的标记。

2019-03-01

项目：添加filter_names.(字符串)参数列出所有的项目端点。要筛选的一个或多个项目名称(用逗号分隔)。
项目：添加include_statistics(数量)参数列出所有的项目端点。是否包括项目统计。可能的值是1和0．
项目：添加include_settings(数量)参数列出所有的项目端点。是否包含项目设置。可能的值是1和0．

2019-02-28

订单:添加订单资源和端点。

2019-02-26

翻译供应商:添加翻译供应商资源和端点。

2019-02-21

支付卡:添加支付卡资源和端点。

2019-02-14

项目对象:添加设置（对象）属性。
项目对象:添加统计数据（对象）属性。

2019-02-07

屏幕截图对象:添加created_at.(字符串)属性。创建日期的截图。

2019-01-10

任务:添加closing_tags(数组)的参数更新任务端点。

2019-01-09

团队用户组:添加团队用户对象

2019-01-04

任务:添加语言．组(数组)的参数创建任务和更新任务端点。
任务:添加语言．组(数组)的参数列出所有任务和检索一个任务端点。

2019-01-02

键:添加filter_qa_issues(字符串)参数列出所有密钥端点。筛选键至少有一个QA问题(逗号分隔)。可能的值是spelling_and_grammar，占位符，超文本标记语言，url_count，网址，Email_Count.，电子邮件，括号，数字，leading_whitespace和trailing_whitespace．
翻译:添加filter_qa_issues(字符串)参数列出所有翻译端点。过滤至少有一个QA问题(逗号分隔)的翻译。可能的值是spelling_and_grammar，占位符，超文本标记语言，url_count，网址，Email_Count.，电子邮件，括号，数字，leading_whitespace和trailing_whitespace．

2018-12-14

键:添加keys_locked(int)返回参数删除多个键和删除一个关键端点。端点将返回keys_removed＝假如果所有的键都有锁定翻译。
翻译:添加filter_lang_id(字符串)参数列出所有翻译端点。仅为显示的语言ID返回翻译。
翻译:添加filter_is_reviewed.(字符串)参数列出所有翻译端点。过滤被审查的翻译。可能的值是1和0．

2018-12-11

任务:添加是否锁定翻译（布尔）参数到更新任务端点。

2018-12-10

任务:添加是否锁定翻译（布尔）参数到创建任务端点。
任务:添加是否锁定翻译（布尔）参数到列出所有任务端点。
任务:添加是否锁定翻译（布尔）参数到检索一个任务端点。

2018-11-29

任务:添加closing_tags(数组)的参数创建任务端点。
任务:添加closing_tags(数组)的参数列出所有任务端点。
任务:添加closing_tags(数组)的参数检索一个任务端点。

2018-11-22

任务：添加task_type(字符串)参数创建任务终点。可能的值是翻译或回顾．
任务：添加parent_task_id(字符串)参数创建任务终点。已完成的任务parent_task_id参数集将排队，直到父任务完成。只能将单个子任务分配给父任务。只能为子任务定义赋值，作用域将从父任务继承。
任务：添加can_be_parent（布尔）参数到列出所有任务端点。只有带有此标志的任务才能被使用parent_task_id参数。
任务：添加task_type(字符串)参数列出所有任务终点。可能的值是翻译或回顾．
任务：添加parent_task_id(数量)参数列出所有任务端点。
任务：添加can_be_parent（布尔）参数到检索一个任务端点。
任务：添加task_type(字符串)参数检索一个任务终点。可能的值是翻译或回顾．
任务：添加parent_task_id(数量)参数检索一个任务端点。
任务：修改键如果不需要(array)参数parent_task_id参数在创建任务请求。
任务:添加额外的状态（字符串）参数值排队．这将是默认状态，如果parent_task_id在创建任务时指定。