柚卡开发者文档
柚卡(yuzuca)是一套面向第三方应用接入的商业 SaaS 授权与订阅平台。它帮助接入方把“客户授权、套餐开通、额度校验、卡密兑换、用量扣减”统一收敛到一套后台和一组标准 API 中。
这套文档只面向接入开发者,重点回答四类问题:
- 我能用柚卡做什么
- 接入前需要在后台配置什么
- HTTP API 应该怎么调用
- SDK 应该怎么初始化和处理错误
推荐阅读顺序:
- 先看概览,快速理解产品能力与适用场景。
- 再看核心概念,建立项目、客户、功能、套餐、订阅、卡密之间的关系。
- 按接入指南完成后台配置和业务接入。
- 最后把HTTP API和TypeScript SDK作为日常参考。
如果你只想尽快联通一次完整流程,建议直接从接入指南开始。
概览先理解平台能做什么
快速了解柚卡的产品定位、适用场景和接入边界。
核心概念建立统一业务模型把项目、客户、功能、套餐、订阅和卡密之间的关系一次看清。
接入指南按顺序走完整接入流程从后台准备到业务调用,覆盖接入前最常见的问题。
HTTP API查接口、字段和错误码适合服务端直接调用,包含通用约定、请求示例和返回语义。
SDK更快接入 TypeScript 项目查看初始化方式、方法封装、错误处理和常见调用示例。
推荐阅读路径
1
看概览和核心概念
先统一术语和建模方式,避免后续对接口字段和后台配置产生理解偏差。
2
完成后台准备
创建项目、功能、套餐、测试客户和 API Key,必要时准备卡密。
3
联通 API 或 SDK
先做启动自检,再接权限判断、扣量链路和兑换开通场景。