Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: 🎸 添加ArkStore的插件与应用接入文档 #1366

Merged
merged 1 commit into from
Oct 24, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions docs/ 商业合作指南/ ArkID开发商/ 插件.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# 插件接入

## 创建插件

### ArkID插件

1.在ArkID中点击应用管理-应用列表-本地应用,点击开发与代理,跳转到ArkStore

[![Bbbgph.png](https://v1.ax1x.com/2022/10/24/Bbbgph.png)](https://x.imgtu.com/i/Bbbgph)

2.在Arkstore中点击开发商-插件管理-仓库管理,上传插件所在的gitee仓库或者zip压缩包

[![Bbb5yZ.png](https://v1.ax1x.com/2022/10/24/Bbb5yZ.png)](https://x.imgtu.com/i/Bbb5yZ)

!!! 注意
名称必填,仓库分支与上传文件任选其一

3.如果选择gitee方式来创建仓库,并且仓库为私有仓库,需要授权龙归来访问您的gitee仓库,公开gitee仓库和zip压缩包方式可以跳过此步<br/>
点击授权
[![BbbAUU.png](https://v1.ax1x.com/2022/10/24/BbbAUU.png)](https://x.imgtu.com/i/BbbAUU)

跳转到gitee
[![BbbGoH.png](https://v1.ax1x.com/2022/10/24/BbbGoH.png)](https://x.imgtu.com/i/BbbGoH)

同意授权
[![BbbV2q.png](https://v1.ax1x.com/2022/10/24/BbbV2q.png)](https://x.imgtu.com/i/BbbV2q)

4.导入插件, 插件导入后会展示在插件包管理中<br/>
点击导入插件
[![BbbAUU.png](https://v1.ax1x.com/2022/10/24/BbbAUU.png)](https://x.imgtu.com/i/BbbAUU)

插件包管理
[![BbbhG9.png](https://v1.ax1x.com/2022/10/24/BbbhG9.png)](https://x.imgtu.com/i/BbbhG9)

5.设置价格,详情请见[**价格规则**](../#_2)<br/>
点击设置价格
[![Bbb8tY.png](https://v1.ax1x.com/2022/10/24/Bbb8tY.png)](https://x.imgtu.com/i/Bbb8tY)

设置价格
[![BbbKj4.png](https://v1.ax1x.com/2022/10/24/BbbKj4.png)](https://x.imgtu.com/i/BbbKj4)

6.提交审核

[![Bbb8tY.png](https://v1.ax1x.com/2022/10/24/Bbb8tY.png)](https://x.imgtu.com/i/Bbb8tY)

7.龙归审核通过后,插件上架完成,所有ArkID的用户在其插件商店中都能看到该插件。
53 changes: 53 additions & 0 deletions docs/ 商业合作指南/ ArkID开发商/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# ArkID开发商

如果您有开发能力,或者独立运营自己的SaaS产品,只通过ArkID账号访问ArkStore,即可成为ArkID开发商。

## 开发商条件

* 任何个人或企业
* 有开发自研能力
* 拥有ArkID账号
* 访问ArkStore

开发商可以向ArkID生态提供生产两类产品:[**ArkID插件**](./%20插件/) 与 [**SaaS应用**](./应用/)。

## 价格规则

### 商店支付

插件只能选择商店支付的方式,应用可以是商店支付或者应用内支付的方式。

无论是插件还是应用,开发商都可以设置价格。

价格分两类:**购买价格** 与 **租赁价格**,两种价格的组成是相同的。

价格包含两个元素:**市场指导价** 与 **成本折扣**

市场指导价的单位为: x元/y人/z天

* 当x=0,则被视为免费
* 当y=0,则被认为不限人数
* 当z=0,则被认为不限天数

成本折扣可以为0-1之间的任何一个两位小数。

!!! 注意
每成交一个产品,开发商实际获得的收益为:市场指导价 * 成本折扣

价格可以设置多条,以满足不同的定价策略。

### 应用内支付

你的应用可以不通过商店支付,而是用户自行在你的应用内支付页面完成支付。

这种情况,需要你跟龙归签署相关合作协议,并商定好分成比例,定期与龙归结算即可。

## 订单记录

在ArkStore中,点击 费用中心-开发商订单 即可查看

## 提现

在ArkStore中,点击 费用中心-提现申请 即可发起申请,后台审核完后会打款。

微信分账功能正在接入。
98 changes: 98 additions & 0 deletions docs/ 商业合作指南/ ArkID开发商/应用.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
# 应用接入

## 创建应用

### SaaS应用

#### OIDC

1.在ArkID中点击应用管理-应用列表-本地应用,点击开发与代理,跳转到ArkStore

[![Bbbgph.png](https://v1.ax1x.com/2022/10/24/Bbbgph.png)](https://x.imgtu.com/i/Bbbgph)

2.在ArkStore中点击开发商-应用管理-中心ArkID-应用管理-应用列表-本地应用-创建,来创建应用<br/>
点击创建
[![Bb8yEt.png](https://v1.ax1x.com/2022/10/24/Bb8yEt.png)](https://x.imgtu.com/i/Bb8yEt)

创建应用
[![Bb8NyJ.png](https://v1.ax1x.com/2022/10/24/Bb8NyJ.png)](https://x.imgtu.com/i/Bb8NyJ)

3.对新创建的应用,点击协议配置,选择OIDC-platform协议,并完成应用接入

[![Bb8EoL.png](https://v1.ax1x.com/2022/10/24/Bb8EoL.png)](https://x.imgtu.com/i/Bb8EoL)

!!! 提示
OIDC-platform就是OIDC协议,只是该类型的应用可以被整个平台所有租户访问。你可以按照OIDC的接入流程接入即可,只是用户参数中会增加:租户标识。

4.点击开发商-SaaS应用-添加应用,接入方式选择OIDC,应用ID输入步骤2中创建的应用ID(可通过点击步骤2中创建应用的编辑按钮来获取)<br/>
点击添加应用
[![Bb83p7.png](https://v1.ax1x.com/2022/10/24/Bb83p7.png)](https://x.imgtu.com/i/Bb83p7)

添加应用
[![Bb8u2B.png](https://v1.ax1x.com/2022/10/24/Bb8u2B.png)](https://x.imgtu.com/i/Bb8u2B)

获取应用ID
[![Bb8qUG.png](https://v1.ax1x.com/2022/10/24/Bb8qUG.png)](https://x.imgtu.com/i/Bb8qUG)

5.设置价格,详情请见[**价格规则**](../#_2)<br/>
点击设置价格
[![Bb8l8I.png](https://v1.ax1x.com/2022/10/24/Bb8l8I.png)](https://x.imgtu.com/i/Bb8l8I)

设置价格
[![Bb87tV.png](https://v1.ax1x.com/2022/10/24/Bb87tV.png)](https://x.imgtu.com/i/Bb87tV)

6.提交审核

[![Bb8l8I.png](https://v1.ax1x.com/2022/10/24/Bb8l8I.png)](https://x.imgtu.com/i/Bb8l8I)


7.龙归审核通过后,应用上架完成,所有ArkID的用户在其应用商店中都能看到该应用。

#### 自定义认证协议

如果你的应用使用的是其它非标准协议,请联系我们。

#### 账密代填

如果你的应用暂时无法通过OIDC接入,我们还推荐使用账密代填的方式。

创建账密代填应用与创建OIDC应用相似,只需在步骤3中协议配置选择AutoFormFill,同时在步骤4中选择表单代填即可。

账密代填并非单点登录的协议,只是会在浏览器中记录对应站点的账号密码,并自动填入并点击登录。

如果该网站使用了如验证码等额外的方式,则不适用账密代填。

#### 推广链接

如果当前应用不支持上述各类情况,你可以仅仅上传一个ArkID的专属推广链接,并记录下该用户后续的注册,登录,付费等行为,用来作为与ArkID分账的依据。

通常这种情况,支付会使用内付费的形式,你需要联系我们。


### 私有化部署应用

1.在ArkID中点击应用管理-应用列表-本地应用,点击开发与代理,跳转到ArkStore

[![Bbbgph.png](https://v1.ax1x.com/2022/10/24/Bbbgph.png)](https://x.imgtu.com/i/Bbbgph)

2.在Arkstore中点击开发商-应用管理-私有部署应用-添加应用,上传Helm Charts的tgz格式压缩包<br/>
点击创建
[![Bb8gpP.png](https://v1.ax1x.com/2022/10/24/Bb8gpP.png)](https://x.imgtu.com/i/Bb8gpP)

上传文件
[![Bb8hGw.png](https://v1.ax1x.com/2022/10/24/Bb8hGw.png)](https://x.imgtu.com/i/Bb8hGw)

5.设置价格,详情请见[**价格规则**](../#_2)<br/>
点击设置价格
[![Bb8Kje.png](https://v1.ax1x.com/2022/10/24/Bb8Kje.png)](https://x.imgtu.com/i/Bb8Kje)

设置价格
[![Bb87tV.png](https://v1.ax1x.com/2022/10/24/Bb87tV.png)](https://x.imgtu.com/i/Bb87tV)

4.提交审核

[![Bb8Kje.png](https://v1.ax1x.com/2022/10/24/Bb8Kje.png)](https://x.imgtu.com/i/Bb8Kje)

7.龙归审核通过后,应用上架完成,所有ArkID的用户在其应用商店中都能看到该应用。


101 changes: 0 additions & 101 deletions docs/ 商业合作指南/ 开发商.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/ 商业合作指南/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

您可以通过以下三种方式来参与并共建ArkID生态:

* 成为[**ArkID开发商**](./%20%20开发商/)
* 成为[**ArkID开发商**](./%20%20ArkID开发商/)
* 成为[**ArkID代理商**](./%20代理商/)
* 成为[**ArkID运营商**](./%20运营商/)

Expand Down