跳转到主要内容
1签 (OneSign)

应用分发快速入门

本页内容

本教程以一个普通分发应用为例,完成“创建应用 → 上传校验 → 确认发布 → 设置下载页”的接入流程。使用已有应用时,从上传更新开始。

前提条件

  • 自己的 API 应用与长期 AccessKey 已获准读取、创建、上传及必要的分发设置能力。
  • 准备真实 IPA 或 APK,并确认账号可用空间和上传限制。
  • 下载并解压通用 Python SDK。源码包中的企业签名命令行工具用于企业签名,本教程直接使用通用客户端和上传助手。

初始化 SDK

按Python SDK 入门配置服务端环境变量,先确认调用身份。其他语言可在接口页选择对应 SDK 示例。

Python SDK
import os
from cloudsign import Client

client = Client(
    os.environ["CLOUDSIGN_BASE_URL"],
    os.environ["CLOUDSIGN_ACCESS_KEY_ID"],
    os.environ["CLOUDSIGN_ACCESS_KEY_SECRET"],
)
identity = client.get_identity()["data"]
print(identity["owner_id"])

创建分发应用

从真实包取得名称与包名,Android 使用 apk,iOS 使用 ipa。为这次创建保存幂等键,再调用下方函数。保存返回的应用 ID与预留截止时间。

Python SDK
def create_distribution_app(client, name, bundle_id, platform, create_key):
    return client.create_app(
        "distribution", platform, name, bundle_id, create_key
    )["data"]

已经有应用时,按名称或包名查询并使用原应用 ID,跳过创建步骤。

上传安装包

调用上传助手时传入真实路径和已保存的上传幂等键。首次没有上传任务 ID 时传 None,并提供将任务 ID 写入自己业务记录的回调;助手会先调用它,再开始传输。

Python SDK
def transfer_distribution_file(client, app_id, path, upload_key,
                                saved_upload_id, save_upload_id):
    from cloudsign.uploader import upload_file
    # save_upload_id 必须先将任务 ID 持久保存;失败时应抛出异常。
    return upload_file(
        client, app_id, path, idempotency_key=upload_key,
        upload_id=saved_upload_id, on_upload=save_upload_id,
    )["data"]

如果回调无法保存,应抛出异常停止传输。中断后从业务记录恢复相同的上传任务 ID,不能用新的任务代替。文件全部传输后,查询上传任务;只有 state=succeeded 且取得 version_id 才进入下一步。详见上传与更新安装包。

确认发布并设置下载页

读取版本列表,确认新版本是否为 is_current。读取下载页当前设置,再保存介绍;下面的函数保留现有模板和语言,并带回原修订号。

Python SDK
def update_download_introduction(client, app_id, introduction, write_key):
    current = client.get_distribution_settings(app_id)["data"]
    return client.update_distribution_settings(
        app_id, current["revision"], current["template_id"],
        current["language"], introduction, write_key,
    )["data"]

模板或语言需要变更时,从设置响应的可选值中选择。保存后打开平台配置的公开分发地址检查页面,安装用户无需先登录平台。

继续接入