Skip to content

关于 翻译

访问范围

需要多个访问范围—请参阅每个端点以了解访问范围要求。

需要访问受保护的客户数据。

翻译服务是 Genstore 平台的基础服务组件,提供强大的业务数据翻译能力。通过翻译服务,业务系统可实现数据的多语言翻译,确保业务数据能被翻译成不同的目标语言。

核心功能

  • 翻译数据:获取业务数据并将业务数据翻译成目标语言,翻译后将数据写回到业务服务中。

使用场景

  • 店铺添加语言:用户在店铺后台添加新语言后,可以将店铺中已有的各业务数据翻译成新添加的语言。

接口

POST /api/202412/translate: 翻译全部数据

POST /api/202412/translate/{domainName}/{bizId}: 翻译指定数据

PUT /api/202412/translate/business/{domainName}: 保存翻译后的业务数据

GET /api/202412/translate/business: 获取可翻译的业务类别

GET /api/202412/translate/business/{domainName}: 获取可翻译业务数据

GET /api/202412/translate/languages: 获取语言列表

翻译 对象

翻译对象。

属性

translateobject
翻译的任务信息。
- 收起属性
targetLanguagestring
翻译的目标语言。
completionStatusnumber
翻译完成的状态。枚举值:未翻译 - 0;翻译中 -1;已完成 - 2;任务异常 - 3。
bash
{
  "translate": {
    "targetLanguage": "en-us",
    "completionStatus": "1"
  }
}

POST 翻译全部数据

翻译全量的业务数据,翻译后会将翻译结果写回业务进行保存。

访问范围

需要以下任意访问权限: write_translate

接口

POST /api/202412/translate 

请求参数

targetLanguagestring
翻译的目标语言。

响应数据

translateobject
翻译全部数据的任务信息。
- 收起属性
targetLanguagestring
翻译的目标语言。
completionStatusboolean
翻译完成的状态。枚举值:未翻译 - 0;翻译中 -1;已完成 - 2;任务异常 - 3。
bash
curl -X POST \ 
https://{shop}.genmystore.com/api/202412/translate" \ 
-H "X-Genstore-Access-Token: {access_token}" \ 
-H "Content-Type: application/json" \ 
-d '{
	"targetLanguage":"en-us"
}'
json
HTTP/1.1 200 OK
{
  "translate": {
    "targetLanguage": "en-us",
    "completionStatus": "1"
  }
}

POST 翻译指定数据

翻译指定的业务数据,翻译后会将翻译结果写回业务进行保存。

访问范围

需要以下任意访问权限: write_translate

接口

POST /api/202412/translate/{domainName}/{bizId} 

请求参数

targetLanguagestring
翻译的目标语言。
bizIdstring
业务数据的唯一标识符。

响应数据

translateobject
- 收起属性
bizIdstring
业务数据的唯一标识符。
bizDataListarray
业务数据内容。
+ 展开属性
bash
curl -X POST \ 
https://{shop}.genmystore.com/api/202412/translate/{domainName}/{bizId}" \ 
-H "X-Genstore-Access-Token: {access_token}" \ 
-H "Content-Type: application/json" \ 
-d '{
	"targetLanguage":"en-us",
	"bizId":"100001"
}'
json
HTTP/1.1 200 OK
{
  "translate": {
    "bizId": "100001",
    "bizDataList": [
      {
        "reference": "苹果",
        "fieldName": "goodsName",
        "targetVal": "apple"
      }
    ]
  }
}

PUT 保存翻译后的业务数据

将业务数据翻译成目标语言后,通过该接口保存已翻译的数据。

访问范围

需要以下任意访问权限: write_translate

接口

PUT /api/202412/translate/business/{domainName} 

请求参数

targetLanguagestring
翻译的目标语言。
listarray
业务数据列表,数量不能超过 50 条。
+ 展开属性

响应数据

businessarray
业务数据对象。
- 收起属性
bizIdstring
业务数据的唯一标识符。
bizDataListarray
业务数据的内容列表。
+ 展开属性
bash
curl -X PUT \ 
https://{shop}.genmystore.com/api/202412/translate/business/{domainName}" \ 
-H "X-Genstore-Access-Token: {access_token}" \ 
-H "Content-Type: application/json" \ 
-d '{
	"targetLanguage":"en",
	"list":[
		{
			"bizId":"100001",
			"bizDataList":[
				{
					"reference":"苹果",
					"targetVal":"apple",
					"extraTransData":"flag1",
					"fieldKey":"goodsName",
					"subBizDataList":[
						{
							"targetVal":"blue",
							"extraTransData":"flag1",
							"fieldKey":"goodsColor"
						}
					]
				}
			]
		}
	]
}'
json
HTTP/1.1 200 OK
{
  "business": [
    {
      "bizId": "100001",
      "bizDataList": [
        {
          "reference": "苹果",
          "fieldName": "goodsName",
          "targetVal": "apple"
        }
      ]
    }
  ]
}

GET 获取可翻译的业务类别

获取店铺支持翻译的业务类别。

访问范围

需要以下任意访问权限: read_translate write_translate

接口

GET /api/202412/translate/business 

请求参数

{}

响应数据

businessarray
业务的类别。
- 收起属性
namestring
业务类别的名称。
sortnumber
业务类别的展示排序,值小的在前。
childarray
业务类别的二级类别。
+ 展开属性
bash
curl -X GET \ 
https://{shop}.genmystore.com/api/202412/translate/business" \ 
-H "X-Genstore-Access-Token: {access_token}" \
json
HTTP/1.1 200 OK
{
  "business": [
    {
      "name": "Settings",
      "sort": "0",
      "child": [
        {
          "domainName": "notifactions",
          "name": "Notifications",
          "sort": "0",
          "queryParameter": [
            {
              "name": "上架",
              "value": "active",
              "key": "status"
            }
          ]
        }
      ]
    }
  ]
}

GET 获取可翻译业务数据

获取业务模块需要翻译的数据列表。

访问范围

需要以下任意访问权限: read_translate write_translate

接口

GET /api/202412/translate/business/{domainName} 

请求参数

queryParameterstring
业务数据的查询参数。
idsnumber
业务数据的唯一标识,不同的业务数据标识用逗号隔开。
targetLanguagestring
翻译的目标语言。
limitnumber
查询数量限制,默认 50,不能超过 250。
pageTokenstring
加密后的请求参数,用于翻页操作(上一页、下一页),直接取该字段解析访问。

响应数据

businessobject
业务数据的对象。
- 收起属性
totalnumber
业务数据的总数。
listarray
业务数据列表。
+ 展开属性
bash
curl -X GET \ 
https://{shop}.genmystore.com/api/202412/translate/business/{domainName}" \ 
-H "X-Genstore-Access-Token: {access_token}" \
json
HTTP/1.1 200 OK
{
  "business": {
    "total": "10000",
    "list": [
      {
        "bizName": "Foxconn",
        "bizId": "100001",
        "bizDataList": [
          {
            "reference": "苹果",
            "groupName": "Product Options",
            "fieldName": "goodsName",
            "targetVal": "apple",
            "titleName": "collection1",
            "extraTransData": "flag1",
            "richText": "false"
          }
        ],
        "bizImg": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEUAAABFCAYAAAAcjSspAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAAEnQAABJ0Ad5mH3gAAAH2SURBVHhe7ZjNjcIwEEa3Hi5bBRUg0QA1cKIAyoALfbCiEqAQLyQT1iQvXv+QQKTvSXMIINvzMp44fDnRQVIASQEkBZAUQFIASQEkBZAUQFIASQEkBZAUQFIASQEkBZAUQFKA90o5bt3se+7WR7v+EJKk/GzmbrY52dULGEDKdb9ys+XBXe06hwQp59uEdRKL/dk+K2QIKbcxF7cxS27esxRbZGlEJ5kj5XKoky6Krfux4QiQsnK7i12nYgseQ8orq6tNj5Sz2y3JcCDu+3hkKVX/aOaPinCFNCQ12pczRKX0fF8LLJViC46NbvM9uTX8Li+8ZN4vJaa/1MlnPZEKKqUrLi1Ccw5YKRFMc/t8bqW8R8oYZEupb9aIT5+SBpl4xsmR4lVwJaV9pLdKaZ9oG4Exc/VKwe0QKt3o7eaRIaW9Dar3Mb8CmjVubD1Hk9RExHvR5CqlktBK7PGi2lSJjdlUR2q/m1il8NoevYVO1TZHbD+5My0pT3N4ryJ+/8A1er/9hO1T7/mC8BL++z+nThJvXFC05faPmLRKCZFTKUnc19Uzvol4REQ1hAApQlIASQEkBZAUQFIASQEkBZAUQFIASQEkBZAUQFIASQEkBZAUQFIASQEkBZAUQFIASQEkBZAUQFIASQEkBZAUQFIASQEkpYNzv/VNGFHwk0kpAAAAAElFTkSuQmCC"
      }
    ]
  }
}

GET 获取语言列表

获取店铺支持的语言列表。

访问范围

需要以下任意访问权限: read_translate write_translate

接口

GET /api/202412/translate/languages 

请求参数

{}

响应数据

languagesobject
语言列表。
- 收起属性
publishedListarray
已经发布的语言列表。
+ 展开属性
unPublishedListarray
未发布的语言列表。
+ 展开属性
bash
curl -X GET \ 
https://{shop}.genmystore.com/api/202412/translate/languages" \ 
-H "X-Genstore-Access-Token: {access_token}" \
json
HTTP/1.1 200 OK
{
  "languages": {
    "publishedList": [
      {
        "translateStatus": "true",
        "isDefault": "true",
        "name": "en-us",
        "language": "en-us",
        "marketNameList": [
          "marketA"
        ]
      }
    ],
    "unPublishedList": [
      {
        "translateStatus": "false",
        "isDefault": "false",
        "name": "zh-cn",
        "language": "zh-cn",
        "marketNameList": [
          "marketB"
        ]
      }
    ]
  }
}