Joystick 快速入门
预计完成时间:8分钟。
1. 了解层次结构
组件 | 描述 |
---|---|
组织 | - "组织" 代表您的公司、工作室或工作组。 - 一个组织可以有多个产品。 - 您所有产品的用户可以在组织级别进行管理。 - 用户可以是组织的"所有者"、"编辑者"或"成员"。 |
产品 | - "产品" 可以创建以匹配您正在构建的每个独特应用或游戏。 - 用户可以创建或被授权访问一个或多个产品。 - 产品是您邀请团队其他成员合作的地方。 |
环境 | - 每个产品可以有多个 "环境"。 - 这些可以对应于您的工作流程和管道设置方式。 - 在每个环境中,可以有许多配置/内容。 |
内容 | - 内容是您的 JSON。 - 内容存储在每个环境中。 - 您可以轻松地在环境之间推送和同步配置内容。 |
API 密钥 | - API 密钥 在环境级别提供和管理。 - 每个环境都将拥有自己的 API 密钥,只能访问该环境中的内容。 - 要访问不同环境中的相同配置,您将必须在应用实例中切换环境密钥。 |
2. 创建一个帐户
3. 创建一个产品
"产品" 是应为任何特定应用或游戏配置的地方。当您首次登录时,您将拥有一个空的组织,并有创建产品的选项。
输入 | 描述 |
---|---|
产品名称 | 产品的友好名称。可以有空格。 |
创建产品后,应显示卡片。点击它以打开产品。
4. 创建一个环境
"环境" 是您的配置的容器。典型的设置可能有四个环境:"开发"、"QA"、"暂存"和"生产"。使用 Joystick,您可以轻松地在环境之间同步/提升配置内容。让我们创建一个环境开始。
Note
一个环境应该包含您的产品/应用所需的一整套配置内容。您可以根据工作流程创建所需的尽可能多的环境。
输入 | 描述 |
---|---|
名称 | 此环境的简短、友好的名称。 |
描述 | 关于此环境及其使用方式的简短附加信息。 |
颜色和图标 | 用于视觉识别环境。例如,您可能希望将"生产"设置为红色。 |
您会看到您的环境卡片。点击它进入环境。
5. 添加配置
当前环境为空。在此处向 Joystick 添加您的第一部分配置/内容。它可以是您希望提供给应用程序的任何 JSON 内容。
这是 Joystick 的配置内容编辑器。您可以在此处放置任何有效的 JSON 配置。我们不会限制您使用简单的键:值对。
输入 | 描述 |
---|---|
内容 ID | 此内容 ID 必须在每个环境中都是唯一的。这是通过 API 检索内容所使用的标识符。 |
描述 | 描述此配置版本的用途,以便其他人可以理解更改。最好保持简短且具有描述性。 |
文件夹 | 将放置此内容的文件夹。您稍后可以移动内容。 |
尝试添加此简单片段然后保存。
支持的内容类型
我们支持 JSON,具有许多功能,包括验证、ab 测试和模式保护。 我们还支持任何字符串格式配置,包括 XML、YAML、INI、纯文本。 了解更多。
点击右上角的"Save",您将被带到内容查看器。标记为Active的顶部修订版可通过 API 获取。
6. 生成 API 密钥
API 密钥允许您从环境中获取内容。点击顶部的环境名称,然后选择“环境 API 密钥”以进入 API 密钥管理器。创建您的第一个 API 密钥!
输入 | 描述 |
---|---|
密钥名称 | 一个简短、友好的名称,用于识别此密钥及其用途。 |
密钥权限 | 对于此示例,请选择“只读”。 |
重要提示
创建密钥后,它将出现在列表中。可以在此处撤销 API 密钥。
7. 通过 API 获取您的配置内容
我们有 SDKs!
我们为 Javascript、Unity、Python 等提供 SDKs。查看我们的 SDKs!。
拥有API密钥后,您就可以获取内容了。我们的API非常轻量。
请求
端点
将 :contentId 替换为您创建的配置内容 ID(如果您按照示例进行操作,ContentId 就是 "greetings
")。:contentId 不区分大小写。
头部
头部 | 值 | 是否必需 | 注释 |
---|---|---|---|
Content-Type |
application/json | 是 | |
X-Api-Key |
您的 API 密钥 | 是 | 在第 6 步中创建的 API 密钥。 |
请求体
请求体应为 JSON 格式,且不能为空。至少应包含以下片段。如果您希望为段或单个用户提供动态内容,您需要使用 u
和 p
属性。您可以在我们的 API 集成指南 中了解更多。
示例
curl --location --request POST 'https://api.getjoystick.com/api/v1/config/:contentId/dynamic' \
--header 'X-Api-Key: 您的-API-密钥' \
--header 'Content-Type: application/json' \
--data-raw '{"u": "", "p": {}}'
故障排查
遇到问题?查看我们的故障排查指南。
响应
默认情况下,您的内容作为响应体中的 "data" 对象返回。
其他参数用于细分和 ab 测试;可以选择性关闭。查看 API 参考 以获取其他选项...
- 获取配置,不带
"data"
包装。 - 序列化获取配置。
- 同时获取多个配置内容。
接下来是什么?
这只是我们在 Joystick 中拥有的功能的冰山一角。