You need to enable JavaScript to run this app.
导航

文案拉取 API

最近更新时间2023.11.15 15:46:35

首次发布时间2022.06.06 21:39:31

适用场景

目前我们提供了 Golang 以及 Web(包括 node.js)的文案拉取 SDK,对于其他场景,比如 Java 或者 Python 服务端,我们暂时没有提供封装好的 SDK。在此类场景下,可以使用文案拉取 API 进行文案拉取。

API 域名

国内:starling-public.zijieapi.com (从国内机房拉取)
海外:starling-public.byteintlapi.com(从海外机房拉取)

使用方式

备注:以国内域名为例

第一步 获取鉴权信息

接口地址:
https://starling-public.zijieapi.com/v3/get_auth_token/$api_key/$project_id/$namespace_id/

接口方法: POST

参数说明:

参数名类型描述
api_keystring项目 api key
project_idint项目 id
namespace_idint空间 id

api_key、project_id、namespace_id 可以在 starling 控制台获取。

alt

alt

接口响应:

{
	"data": {
		"token": "xxxx" // 鉴权 token,作为第二步的请求头参数
	},
	"status": 200
}

Demo:

curl --location --request POST 'https://starling-public.zijieapi.com/v3/get_auth_token/$api_key/$operator_id/$project_id/$namespace_id/'

第二步 拉取文案

接口地址:

环境接口地址
正式环境https://starling-public.zijieapi.com/text2/$namespace_id/$locale
灰度环境https://starling-public.zijieapi.com/text_gray2/$namespace_id/$locale
测试环境https://starling-public.zijieapi.com/text_test2/$namespace_id/$locale

接口方法: GET

参数说明:
path 参数

参数名类型描述
namespace_idint空间 id
localestring语言,比如 en、zh-CN

alt

locale 可在控制台配置:
alt

请求头参数

参数名类型描述
Authorizationstring第一步获取的 token

接口响应:

{
    "message": {
        "data": { // 文案信息
            "key1": "value1",
            "key2": "value2"
        },
        "version": 1651916743696499000,
        "release_version": "0.0.3"
    },
    "status": 200
}

Demo:

curl --location --request GET 'https://starling-public.zijieapi.com/text2/$namespace_id/$locale' \\
\--header 'Authorization: $token'