Skip to content

bitcv/openPlatform

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

币威开放平台

币威开放平台为第三方开发者提供接入使用币威钱包的一系列服务,分为四种接入方式:

  1. 服务器端共享用户方式,通过简单用户联通,可将项目方的积分转换为币威钱包Token自由流通,可获取用户余额和转账回调。
  2. 服务器端独立用户方式,币威可为项目方用户生成单独的钱包地址,项目方管理用户Token数量,币威钱包提供链上转账的接口。
  3. H5接入方式,第三方开发的H5网页嵌入到币威钱包,共享币威用户,可以利用币威钱包完成用户登录、支付等操作。
  4. APP-SDK输出方式,第三方自己的APP可以嵌入币威提供的SDK(Android和iOS平台),完成用户对接,使自己的APP拥有区块链钱包功能。

接入流程

  1. 请先联系币威团队沟通合适的对接方式,微信号:BlockchainBrothers
  2. 根据接入方式的不同,可能需要提交企业账号或服务器回调地址(URL)等信息。成为开发者后,币威会为第三方开发者提供相关 appId、appsecret等账号信息。
  3. 下载相应SDK代码和demo开始开发。H5和APP-SDK接入一般也需要部分服务器端接口同时对接。

服务器端(共享用户)接入指南:

这里的部分接口,H5接入和APP-SDK接入也同时需要:

  1. 后端签名机制
    签名务必在服务器后端签名,不要把appsecret暴露到app或网页里。
  2. 企业账号转账
    企业账号把资产发放给个人用户。
  3. 用户注册登录及资产、回调等接口
    用户联通相关接口。

服务器端(独立用户)接入指南:

  1. 后端签名机制
    签名务必在服务器后端签名,不要把appsecret暴露到app或网页里。
  2. 用户注册登录、获取地址资产、回调等接口
    独立用户相关接口。

BitcvPay支付接入指南:

  1. 后端签名机制
    签名务必在服务器后端签名,不要把appsecret暴露到app或网页里。
  2. 后端接口
    支付相关接口。
  3. 移动端使用文档
    IOS-SDK使用文档
    Android-SDK使用文档

H5接入指南:

H5接入需要前后端一起对接,其中网页授权登录的流程可采用前后端共同接入或单独后端接入;使用JS-SDK发起支付和分享等操作需要在前端页面接入,并在后端利用appsecret生成签名给前端调用、获取用户信息、生成订单和撤单等。
相关文档:

  1. 后端签名机制
    部分接口调用需要进行数据签名,务必在服务器后端签名,不要把appsecret暴露到网页里。
  2. 网页授权登录
    如果用户在币威钱包客户端中访问第三方网页,可以通过币威钱包网页授权机制,来获取用户基本信息,进而实现业务逻辑。
  3. JS-SDK 使用文档
    通过使用币威 JS-SDK,网页开发者可借助币威APP使用支付、分享等能力,未来还将开放更多功能。
  4. 个人用户支付
    后端创建订单,请求币威开放平台获取订单号,再由前端用户发起支付。
  5. 企业账号转账
    企业账号把资产发放给个人用户。

APP-SDK接入指南:

通过嵌入币威 APP-SDK,项目方App无需开发任何和区块链相关的代码,便拥有了钱包的收款、转账、查询交易记录等所有基本功能。 币威同时开放APP的UI源码,项目方可选择直接导入SDK不需要开发UI(APP接口已经封装好),也可以自行修改UI和调用接口。
服务器端对接请参考上面的文档,APP对接:

1、使用币威SDK,iOS、Android相关文档:
iOS-SDK 使用文档
Android-SDK 使用文档

2、APP源码开发:
客户端APP接口文档

相关功能介绍:

  1. SDK支持全币种,币威钱包支持的币种将会自动体现在SDK中。
  2. SDK主要功能:转账和收款
  3. 为了安全,资产标准超过3000元需要绑定谷歌验证
  4. SDK的数据与币威钱包数据互通
  5. 项目方在接入SDK时,遇到需要将一些数字币发放给用户的情况时候,需要先充值到企业钱包(币威生成的,项目方能调用接口,能查询)再用API接口写入
  6. 手机号验证的用户可以在任何SDK中修改支付密码。
  7. SDK登录有效期7天,如过期需要重新使用手机验证登录
  8. 项目方只能通过接口查询该项目币种的数据,不能查询其他币种资产(防止多SDK数据透明)。

API使用场景:
通过api可以完成企业账户与用户之间的资产划转等交互使用,例如:

  1. 用户初次打开SDK便能看到App的资产
    对企业账号充值资产
    转移企业账号资产到用户手机号
    用户接入SDK就能看到自己的资产了
  2. App积分转换为用户资产
    扣除用户积分
    转移企业账户资产到用户
    用户能实时看到自己资产的变化和交易记录
  3. 扣除用户资产
    通过接口查询用户资产
    发起订单
    用户支付
    企业账户相应的增加了资产