From 6518c9b2138d8e37633a5179a760c783feee86ba Mon Sep 17 00:00:00 2001 From: Harvey Date: Wed, 24 Nov 2021 17:53:45 +0800 Subject: [PATCH] update --- .../docs/en/Data dictionary.md | 195 ------------------ .../docs/en/Parameters Instructions.md | 81 -------- .../artplayer-document/docs/en/UML Diagram.md | 24 --- .../docs/zh-cn/Data dictionary.md | 195 ------------------ .../artplayer-document/docs/zh-cn/Overview.md | 129 ++++++------ .../docs/zh-cn/Parameters Instructions.md | 100 --------- .../docs/zh-cn/UML Diagram.md | 24 --- .../artplayer-document/docusaurus.config.js | 1 + packages/artplayer-document/package.json | 12 +- .../artplayer-document/src/css/custom.css | 11 + .../artplayer-document/src/script/bugfix.js | 12 ++ 11 files changed, 101 insertions(+), 683 deletions(-) delete mode 100644 packages/artplayer-document/docs/en/Data dictionary.md delete mode 100644 packages/artplayer-document/docs/en/Parameters Instructions.md delete mode 100644 packages/artplayer-document/docs/en/UML Diagram.md delete mode 100644 packages/artplayer-document/docs/zh-cn/Data dictionary.md delete mode 100644 packages/artplayer-document/docs/zh-cn/Parameters Instructions.md delete mode 100644 packages/artplayer-document/docs/zh-cn/UML Diagram.md diff --git a/packages/artplayer-document/docs/en/Data dictionary.md b/packages/artplayer-document/docs/en/Data dictionary.md deleted file mode 100644 index e662a4926..000000000 --- a/packages/artplayer-document/docs/en/Data dictionary.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -title: Data dictionary -sidebar_position: 4 ---- - -## Marriage - -| Code | Description | Note | -| ---- | ------------- | ---- | -| 10 | Belum Menikah | | -| 11 | Menikah | | -| 12 | Cerai | | - -## Education - -| Code | Description | Note | -| ---- | ------------------ | ---- | -| 14 | Sekolah Dasar | | -| 16 | SMP | | -| 13 | SMA | | -| 15 | Diploma/Politehnik | | -| 10 | Sarjana | | -| 11 | Master | | -| 12 | Doctor | | -| 17 | Lain-Lain | | - -## House Ownership - -| Code | Description | Note | -| ---- | -------------- | ---- | -| 10 | Rumah Sendiri | | -| 11 | Rumah Keluarga | | -| 12 | Rumah Dinas | | -| 13 | Sewa/Kontrak | | -| 14 | Kost | | -| 15 | Status Kredit | | -| 16 | Lain-Lain | | - -## Religion - -| Code | Description | Note | -| ---- | ----------------- | ---- | -| 10 | Islam | | -| 11 | Kristen Protestan | | -| 12 | Kristen Katolik | | -| 13 | Hindu | | -| 14 | Budha | | -| 15 | Kong Hu Cu | | - -## Work Type - -| Code | Description | Note | -| ---- | ------------- | ---- | -| 10 | Tetap | | -| 11 | Kontrak | | -| 12 | Outsourcing | | -| 13 | Pekerja Lepas | | -| 14 | Pemilik Usaha | | - -## Position - -| Code | Description | Note | -| ---- | ------------------------ | ---- | -| 10 | Direktur/General Manager | | -| 11 | Manajer | | -| 12 | Asisten Manajer | | -| 13 | Staf | | -| 14 | Pemilik | | - -## Industry - -| Code | Description | Note | -| ---- | ------------------------------------------- | ---- | -| 10 | Perdagangan Eceran / Grosir | | -| 11 | Perbankan / Keuangan / Asuransi / Investasi | | -| 12 | Manufaktur | | -| 13 | Properti / Konstruksi | | -| 14 | Pertambangan / Minyak / Gas | | -| 15 | Pendidikan | | -| 16 | Telekomunikasi | | -| 17 | Pariwisata / Hotel / Perhotelan | | -| 18 | Angkutan | | -| 19 | PNS (Pemerintah) | | -| 20 | Konsultan / Akuntansi / Jasa Profesional | | -| 21 | BUMN (Badan Usaha Milik Negara) | | -| 22 | Perkebunan / Pertanian | | -| 23 | TNI / Polisi (Militer / Polisi) | | -| 24 | Hukum | | -| 25 | Teknologi | | -| 26 | Media / Hiburan | | -| 27 | Pemasaran iklan | | -| 28 | Makanan & Minuman | | -| 29 | Layanan medis | | -| 30 | Perikanan | | - -## Office Ownership - -| Code | Description | Note | -| ---- | ------------- | ---- | -| 10 | Milik Sendiri | | -| 11 | Sewa | | - -## Company Size - -| Code | Description | Note | -| ---- | ----------- | ---- | -| 10 | 1-5 | | -| 11 | 5-10 | | -| 12 | 10-25 | | -| 13 | 25-50 | | -| 14 | >50 | | - -## Occupation - -| Code | Description | Note | -| ---- | ------------------------- | ---- | -| 11 | Pensiunan/Purnawirawan | | -| 12 | Pelayaran/Pelaut | | -| 13 | Guru/Pendidikan | | -| 14 | Jasa | | -| 15 | Dokter/Bidan/Mantri | | -| 16 | Ojek Motor | | -| 17 | Sopir | | -| 18 | Peternak | | -| 19 | Pelajar/Mahasiswa | | -| 20 | Buruh/PRT | | -| 21 | Pengrajin Tangan | | -| 23 | Pedagang | | -| 24 | Produksi | | -| 26 | Sewa/Rent | | -| 27 | Transportasi & Komunikasi | | -| 28 | Hiburan | | -| 29 | Pendidikan Non Formal | | -| 30 | Hotel | | -| 31 | Perangkat Desa | | -| 32 | TNI/Polri | | -| 33 | Atlet | | -| 34 | Pengobatan Alternatif | | -| 2 | ABRI | | -| 3 | Pengacara | | -| 35 | Jurnalis / Wartawan | | -| 37 | Profesi | | -| 36 | Wartawan | | -| 6 | Lain-Lain | | -| 38 | Pekerja Lepas | | - -## Income source - -| Code | Description | Note | -| ---- | ---------------------------------- | ---- | -| 10 | Gaji/Upah | | -| 11 | Laba Usaha | | -| 12 | Uang Tabungan | | -| 13 | Menjual/Menggadaikan Aset | | -| 14 | Dari Keluarga/Teman/Sumber Lainnya | | - -## Relationship with emergency contact - -| Code | Description | Note | -| ---- | --------------- | ---- | -| 10 | Pasangan | | -| 11 | Orang Tua | | -| 12 | Saudara Kandung | | -| 13 | Anak | | -| 14 | Teman Kantor | | - -## Apply reason - -| Code | Description | Note | -| ---- | ----------------------------------------- | ---- | -| 10 | Pembelian Handphone / Laptop / Elektronik | | -| 11 | Tagihan Rutin | | -| 12 | Liburan / Rekreasi | | -| 13 | Pembayaran Pajak | | -| 14 | Asuransi | | -| 15 | Pengobatan Medis | | -| 16 | Pendidikan | | -| 17 | Konsumsi Rumah Tangga | | -| 18 | Modal Usaha | | -| 19 | Multiguna | | - -## Document type - -| Code | Description | Note | -| ----------------------- | ------------------------------------ | ---- | -| bank_statement_3_months | Bank statement for the last 3 months | | -| company_id_card | | | -| ID_PNS | | | -| receiptri | | | -| salary_certificate | | | -| salary_slip_3_months | Salary slip for the last 3 months | | -| self_SKU_SIUP_TDP | | | -| SK_PNS | | | -| driver_license | | | -| KTP | | | \ No newline at end of file diff --git a/packages/artplayer-document/docs/en/Parameters Instructions.md b/packages/artplayer-document/docs/en/Parameters Instructions.md deleted file mode 100644 index 14f36b450..000000000 --- a/packages/artplayer-document/docs/en/Parameters Instructions.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: Parameters Instructions -sidebar_position: 3 ---- - -### Instructions for API request parameters - -:::note -NOTE: The following parameters is included in all services (different values). If no parameters for body then pass blank, like body:”” -::: - -| Name|Description|Type|Mandatory|Notes| -| ----|----|----|----|----| -| body|Business parameters|Object|N|Some APIs may require body| -| timestamp|Timestamp|Long|Y|Accurate into a second| -| appId|Apply from AWDA|String|Y| -| v|Version code|String|N|Default 1.0| -| signature|Signature|String|Y|All requests need signature| - -example: - -```json -{ - "body": "1111", - "timestamp": 1488363493, - "signature": "B3C14758F4AF52AE8AA0D4CD1493B137", - "appId": "111", - "v":"1.0" -} -``` - -### Rules for signature - -Rules for signature： - -- Step 1：Sort the parameters alphabetically by key name. Result will be: appId、body、timestamp、v -- Step 2：Combine key and value of all the parameters. Result will be: appId:123456body:{"orderNo":"1234567"}timestamp:1558923813v:1.0 -- Step 3：Add secret to the last of the result from step 2, which will become the signature. Result will be: appId:123456body:{"orderNo":"1234567"}timestamp:1558923813v:1.0yoursecret -- Step 4：MD5 encryption of the signature string. Result will be: `B6F6E3F9ADF4D7558F54BC8B7D9869CC` - - -### Java Sample Codes for Signature - -```java -String[] keys = new String[map.size()]; -int i = 0; -for (Map.Entry entry : map.entrySet()) { - keys[i++] = entry.getKey(); -} -Arrays.sort(keys); -StringBuilder stringBuilder = new StringBuilder(); -for (String key : keys) { - stringBuilder.append(key); - stringBuilder.append(":"); - stringBuilder.append(map.get(key)); -} -stringBuilder.append(secret); -String str=stringBuilder.toString(); -String encodeStr = DigestUtils.md5Hex(str).toUpperCase(); -return encodeStr ; -``` - -### API Response - -| Parameters|DescriptionType|Mandatory|Notes| -| ----|----|----|----|----| -| code|Status code|Integer|Y|

0: Success

Other codes all represent failure, find more details in Code List

| -| message|Status description|String|Y|Code description| -| result|Return data|Object|N|When code=0, there will be business data returned inside result object| - -### Sample response for success request: - -```json -{ - "code": 0, - "message": "Permintaan berhasil", - "result": { - "state": true - } -} -``` \ No newline at end of file diff --git a/packages/artplayer-document/docs/en/UML Diagram.md b/packages/artplayer-document/docs/en/UML Diagram.md deleted file mode 100644 index e124bffa1..000000000 --- a/packages/artplayer-document/docs/en/UML Diagram.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: UML Diagram -sidebar_position: 2 ---- - -### Authorization - -![logo](/img/Authorization.png) - -### Submit Bank Card - -![logo](/img/SubmitBankCard.png) - -### Submit Loan - -![logo](/img/ApplyForLloan.png) - -### Sign Contract - -![logo](/img/ContractContract.png) - -### Payment Inquiry - -![logo](/img/RepaymentInformation.png) diff --git a/packages/artplayer-document/docs/zh-cn/Data dictionary.md b/packages/artplayer-document/docs/zh-cn/Data dictionary.md deleted file mode 100644 index e0c57037f..000000000 --- a/packages/artplayer-document/docs/zh-cn/Data dictionary.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -title: 数据字典 -sidebar_position: 4 ---- - -## 婚姻状况 - -| 编码 | 描述 | 备注 | -| ---- | ------------- | ---- | -| 10 | Belum Menikah | | -| 11 | Menikah | | -| 12 | Cerai | | - -## 教育程度 - -| 编码 | 描述 | 备注 | -| ---- | ------------------ | ---- | -| 14 | Sekolah Dasar | | -| 16 | SMP | | -| 13 | SMA | | -| 15 | Diploma/Politehnik | | -| 10 | Sarjana | | -| 11 | Master | | -| 12 | Doctor | | -| 17 | Lain-Lain | | - -## 宅所有权 - -| 编码 | 描述 | 备注 | -| ---- | -------------- | ---- | -| 10 | Rumah Sendiri | | -| 11 | Rumah Keluarga | | -| 12 | Rumah Dinas | | -| 13 | Sewa/Kontrak | | -| 14 | Kost | | -| 15 | Status Kredit | | -| 16 | Lain-Lain | | - -## 宗教 - -| 编码 | 描述 | 备注 | -| ---- | ----------------- | ---- | -| 10 | Islam | | -| 11 | Kristen Protestan | | -| 12 | Kristen Katolik | | -| 13 | Hindu | | -| 14 | Budha | | -| 15 | Kong Hu Cu | | - -## 工作类型 - -| 编码 | 描述 | 备注 | -| ---- | ------------- | ---- | -| 10 | Tetap | | -| 11 | Kontrak | | -| 12 | Outsourcing | | -| 13 | Pekerja Lepas | | -| 14 | Pemilik Usaha | | - -## 职位 - -| 编码 | 描述 | 备注 | -| ---- | ------------------------ | ---- | -| 10 | Direktur/General Manager | | -| 11 | Manajer | | -| 12 | Asisten Manajer | | -| 13 | Staf | | -| 14 | Pemilik | | - -## 行业 - -| 编码 | 描述 | 备注 | -| ---- | ------------------------------------------- | ---- | -| 10 | Perdagangan Eceran / Grosir | | -| 11 | Perbankan / Keuangan / Asuransi / Investasi | | -| 12 | Manufaktur | | -| 13 | Properti / Konstruksi | | -| 14 | Pertambangan / Minyak / Gas | | -| 15 | Pendidikan | | -| 16 | Telekomunikasi | | -| 17 | Pariwisata / Hotel / Perhotelan | | -| 18 | Angkutan | | -| 19 | PNS (Pemerintah) | | -| 20 | Konsultan / Akuntansi / Jasa Profesional | | -| 21 | BUMN (Badan Usaha Milik Negara) | | -| 22 | Perkebunan / Pertanian | | -| 23 | TNI / Polisi (Militer / Polisi) | | -| 24 | Hukum | | -| 25 | Teknologi | | -| 26 | Media / Hiburan | | -| 27 | Pemasaran iklan | | -| 28 | Makanan & Minuman | | -| 29 | Layanan medis | | -| 30 | Perikanan | | - -## 办公场所所有权 - -| 编码 | 描述 | 备注 | -| ---- | ------------- | ---- | -| 10 | Milik Sendiri | | -| 11 | Sewa | | - -## 公司人数 - -| 编码 | 描述 | 备注 | -| ---- | ----- | ---- | -| 10 | 1-5 | | -| 11 | 5-10 | | -| 12 | 10-25 | | -| 13 | 25-50 | | -| 14 | >50 | | - -## 职业 - -| 编码 | 描述 | 备注 | -| ---- | ------------------------- | ---- | -| 11 | Pensiunan/Purnawirawan | | -| 12 | Pelayaran/Pelaut | | -| 13 | Guru/Pendidikan | | -| 14 | Jasa | | -| 15 | Dokter/Bidan/Mantri | | -| 16 | Ojek Motor | | -| 17 | Sopir | | -| 18 | Peternak | | -| 19 | Pelajar/Mahasiswa | | -| 20 | Buruh/PRT | | -| 21 | Pengrajin Tangan | | -| 23 | Pedagang | | -| 24 | Produksi | | -| 26 | Sewa/Rent | | -| 27 | Transportasi & Komunikasi | | -| 28 | Hiburan | | -| 29 | Pendidikan Non Formal | | -| 30 | Hotel | | -| 31 | Perangkat Desa | | -| 32 | TNI/Polri | | -| 33 | Atlet | | -| 34 | Pengobatan Alternatif | | -| 2 | ABRI | | -| 3 | Pengacara | | -| 35 | Jurnalis / Wartawan | | -| 37 | Profesi | | -| 36 | Wartawan | | -| 6 | Lain-Lain | | -| 38 | Pekerja Lepas | | - -## 收入来源 - -| 编码 | 描述 | 备注 | -| ---- | ---------------------------------- | ---- | -| 10 | Gaji/Upah | | -| 11 | Laba Usaha | | -| 12 | Uang Tabungan | | -| 13 | Menjual/Menggadaikan Aset | | -| 14 | Dari Keluarga/Teman/Sumber Lainnya | | - -## 紧急联系人关系 - -| 编码 | 描述 | 备注 | -| ---- | --------------- | ---- | -| 10 | Pasangan | | -| 11 | Orang Tua | | -| 12 | Saudara Kandung | | -| 13 | Anak | | -| 14 | Teman Kantor | | - -## 借款原因 - -| 编码 | 描述 | 备注 | -| ---- | ----------------------------------------- | ---- | -| 10 | Pembelian Handphone / Laptop / Elektronik | | -| 11 | Tagihan Rutin | | -| 12 | Liburan / Rekreasi | | -| 13 | Pembayaran Pajak | | -| 14 | Asuransi | | -| 15 | Pengobatan Medis | | -| 16 | Pendidikan | | -| 17 | Konsumsi Rumah Tangga | | -| 18 | Modal Usaha | | -| 19 | Multiguna | | - -## 文档类型 - -| 编码 | 描述 | 备注 | -| ----------------------- | ------------------------------------ | ---- | -| bank_statement_3_months | Bank statement for the last 3 months | | -| company_id_card | | | -| ID_PNS | | | -| receiptri | | | -| salary_certificate | | | -| salary_slip_3_months | Salary slip for the last 3 months | | -| self_SKU_SIUP_TDP | | | -| SK_PNS | | | -| driver_license | | | -| KTP | | | \ No newline at end of file diff --git a/packages/artplayer-document/docs/zh-cn/Overview.md b/packages/artplayer-document/docs/zh-cn/Overview.md index f41bb0866..a9415f099 100644 --- a/packages/artplayer-document/docs/zh-cn/Overview.md +++ b/packages/artplayer-document/docs/zh-cn/Overview.md @@ -4,77 +4,90 @@ sidebar_position: 1 slug: /zh-cn --- -## 必读 +## 安装 -- 在生产环境发布前前，请先通过测试环境调试完所有接口及流程后待我方确认无误方可上生产环境 +### 通过 `npm` 安装： -- 在开发过程中，可以使用接口调试工具来在线调试某些接口。 +```bash +$ npm install artplayer +``` -- 在开发出现问题时，可以通过接口调用的返回码查看失败原因或联系我方技术支持人员 +### 通过 `yarn` 安装： -- 所有接口都采用POST方式（包括查询接口） +```bash +$ yarn add artplayer +``` -- 请求和响应的数据都为JSON格式。注：请设置Header的Content-Type为application/json，采用UTF-8字符编码 +然后加载 `artplayer` 模块： -- 所有的接口必须进行接口签名 +```js +// ES6 +import Artplayer from 'artplayer'; -## 更新日志 +// CommonJS +const Artplayer = require('artplayer'); +``` -| 版本 | 日期 | 项目负责人 | 描述 | -| ------- | ---------- | ------- | ------- | -| 1.0.0 | 2019.06.03 | 吕志博 | 初始版本 | +### 通过 `script` 安装： -## 接口说明 +```html + + -| **接口名称** | **描述** | -| -----------------| --------------- | -| user registration|

接口提供方: AWDA

接口调用方 : 合作方

是否必须对接 : 是

接口描述 : 用户创建，必须先创建用户成功后才能调用其他接口

| -| Authorization list inquiry|

接口提供方: AWDA

接口调用方 : 合作方

是否必须对接 : 否

接口描述 : 获取授权列表及用户个人授权状态

| -| Get the authorization detail page|

接口提供方: AWDA

接口调用方 : 合作方

是否必须对接 : 否

接口描述 : 授权第三方授权页面地址

-| Call back for authorization status|

接口提供方: AWDA

接口调用方 : 合作方

是否必须对接 : 否

接口描述 : 通知授权结果

| -| Bank card inquiry|

接口提供方: AWDA

接口调用方 : 合作方

是否必须对接 : 是

接口描述 : 查询绑卡信息

| -| Get bank list|

接口提供方: AWDA

接口调用方 : 合作方

是否必须对接 : 是

接口描述 : 获取支持绑卡的银行列表

| -| Bank card verification|

接口提供方: AWDA

接口调用方 : 合作方

是否必须对接 : 是

接口描述 : 用户绑定用于接收平台放款的银行卡

| -| Submit loan|

接口提供方: AWDA

接口调用方 : 合作方

是否必须对接 : 是

接口描述 : 提交进件信息，进件信息包含（用户个人信息、身份信息、工作信息、紧急联系人信息）

| -| Loan agreement inquiry|

接口提供方: AWDA

接口调用方 : 合作方

是否必须对接 : 是

接口描述 : 查看贷款合同

| -| Sign agreement|

接口提供方: AWDA

接口调用方 : 合作方

是否必须对接 : 是

接口描述 : 合同签约（确认放款）

| -| Get loan information|

接口提供方: AWDA

接口调用方 : 合作方

是否必须对接 : 是

接口描述 : 根据贷款编号查询贷款当前信息（如已放款则包含还款计划）

| -| Get repayment VA|

接口提供方: AWDA

接口调用方 : 合作方

是否必须对接 : 是

接口描述 : 用户还款虚拟账号查询

| -| Push notification|

Provider: Third party

User : AWDA

是否必须对接: 否

接口描述 : 推送贷款状态变更消息

| -| Eligible Check|

接口提供方: AWDA

接口调用方 : 合作方

是否必须对接 : 是

接口描述 : Verify Customer

| -| Get the token for uploading image|

接口提供方: AWDA

接口调用方 : 合作方

是否必须对接 : 否

接口描述 : To get the token which used for api Upload Image (1)

| -| Upload Image (1)|

接口提供方: AWDA

接口调用方 : 合作方

是否必须对接 : 否

接口描述 : By sending file stream with token

| -| Upload Image (2)|

接口提供方: AWDA

接口调用方 : 合作方

是否必须对接 : 否

接口描述 : By sending base64 or url format

| -| Get the redirect url
(For H5 pages of Digital Signature, Loan detail and Repayment detail) |

接口提供方: AWDA

接口调用方 : 合作方

是否必须对接 : 否

接口描述 : Redirect to the specific H5 pages

| + + -## 环境地址说明 + + +``` -测试环境域名：`https://sea-staging.wolaidai.com` +然后你可以通过 `window.Artplayer` 访问到构造函数 -生产环境域名：`https://japi.maucash.id` +## 使用 -注：所有接口调用真实地址为 `环境域名+接口地址` +`Artplayer` 是一个构造函数，通过 `new` 关键字进行实例化 -## 全局状态码说明 +```html + + + + ArtPlayer Demo + + + +
+ + + + +``` -| 返回码| 描述| -| ----|----| -| 0 |请求成功| -| 100| 系统繁忙| -| 300| 请求超时| -| 400| 参数错误| -| 404| 网络异常| -| 600| 数据不存在| -| 999| 其他未知错误| -| 1001| 重复请求| -| 1002| 无效的token| -| 1003| 时间戳有误或已失效（仅处理60S内的请求）| -| 1004| 签名校验不通过| -| 1005| 商户号错误| -| 1006| 参数不能为空| -| 1007| 参数有误| -| 1008| 用户已存在| -| 1009| 用户不存在| -| 1010| 订单不存在| -| 1011| 系统繁忙| -| 1012| 授权信息获取失败| \ No newline at end of file +:::danger 提示 + +播放器的尺寸依赖于容器 `container` 的尺寸，所以你的容器 `container` 必须是有尺寸的 + +::: + +## 演示 + +:::tip 提示 + +本文档里，通过点击代码块前的 `Run Code` 按钮，可以马上进入演示 + +::: + +---------------------------------------------- + +
▶ Run Code
+ +```js +var art = new Artplayer({ + container: '.artplayer-app', + url: '/assets/sample/video.mp4', +}); +``` diff --git a/packages/artplayer-document/docs/zh-cn/Parameters Instructions.md b/packages/artplayer-document/docs/zh-cn/Parameters Instructions.md deleted file mode 100644 index 4f4c7500d..000000000 --- a/packages/artplayer-document/docs/zh-cn/Parameters Instructions.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -title: 入参及出参说明 -sidebar_position: 3 ---- - -### API请求参数说明 - -:::note -注：所有的API接口都包含如下参数（不同的接口只是参数body值不一样），以下具体接口只针对body进行描述若接口，当没有业务参数的时候, body需要赋值为空字符串,即body: "" -::: - -| 参数名称 | 描述 | 类型 | 必填 | 备注 | -| --------- | --------------- | ------ | ---- | -------------------- | -| body | 业务参数 | Object | 否 | 具体接口决定是否必传 | -| timestamp | 时间戳 | Long | 是 | 精确到秒 | -| appId | 平台分配的appId | String | 是 | -| v | 接口版本号 | String | 否 | 默认1.0 | -| signature | 签名 | String | 是 | 见签名生成 | - -例: - -```json -{ - "body": "1111", - "timestamp": 1488363493, - "signature": "B3C14758F4AF52AE8AA0D4CD1493B137", - "appId": "111", - "v":"1.0" -} -``` - -### 接口签名规则 - -签名生成的通用步骤如下： - -- 第一步：将参与签名的参数按照键值(key)进行字典排序 -- 第二步：将排序过后的参数，进行key和value字符串拼接 -- 第三步：将拼接后的字符串末尾加上secret秘钥，合成签名字符串 -- 第四步：对签名字符串进行MD5加密，生成32位的字符串转换为大写 - -### 签名生成过程 - -第一步：将参与签名的参数按照键值(key)进行字典排序 - -例如：将上述请求参数中的body、timestamp、appId、v 进行字典排序。结果为：appId、body、timestamp (精确到秒)、v - -第二步：将排序过后的参数，进行key和value字符串拼接 - -将参数中的key和value按照key的顺序进行字符串拼接。若body为对象的话转成JSON字符串进行签名即可 - -例：appId:123456body:{"orderNo":"1234567"}timestamp:1558923813v:1.0 - -第三步：将拼接后的字符串尾部加上secret秘钥，合成签名字符串 - -将第二步的字符窜首尾拼接上secret。结果为：appId:123456body:{"orderNo":"1234567"}timestamp:1558923813v:1.0yousecret - -第四步：对签名字符串进行MD5加密，生成32位的字符串,并转换大写 - -对生成签名字符串进行MD5加密。结果为：B6F6E3F9ADF4D7558F54BC8B7D9869CC - -### Java 签名代码 - -```java -String[] keys = new String[map.size()]; -int i = 0; -for (Map.Entry entry : map.entrySet()) { - keys[i++] = entry.getKey(); -} -Arrays.sort(keys); -StringBuilder stringBuilder = new StringBuilder(); -for (String key : keys) { - stringBuilder.append(key); - stringBuilder.append(":"); - stringBuilder.append(map.get(key)); -} -stringBuilder.append(secret); -String str=stringBuilder.toString(); -String encodeStr = DigestUtils.md5Hex(str).toUpperCase(); -return encodeStr ; -``` - -### API响应结果说明 - -| 参数名称 | 描述 | 类型 | 必填 | 备注 | -| -------- | -------- | ------- | ---- | --------------------------------------------------- | -| code | 状态码 | Integer | 是 |

0：执行成功

其他编码均为失败，详见码表

| -| message | 状态描述 | String | 是 | 用于描述code | -| result | 详细信息 | Object | 否 | 当code为0时 result为返回的业务数据。 | - -正确响应的JSON - 例： - -```json -{ - "code": 0, - "message": "Permintaan berhasil", - "result": { - "state": true - } -} -``` \ No newline at end of file diff --git a/packages/artplayer-document/docs/zh-cn/UML Diagram.md b/packages/artplayer-document/docs/zh-cn/UML Diagram.md deleted file mode 100644 index ad54c20ce..000000000 --- a/packages/artplayer-document/docs/zh-cn/UML Diagram.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: 参考对接UML时序图 -sidebar_position: 2 ---- - -### Wedefend授权 - -![logo](/img/Authorization.png) - -### 绑定银行卡 - -![logo](/img/SubmitBankCard.png) - -### 申请借款 - -![logo](/img/ApplyForLloan.png) - -### 合同签约 - -![logo](/img/ContractContract.png) - -### 还款信息 - -![logo](/img/RepaymentInformation.png) \ No newline at end of file diff --git a/packages/artplayer-document/docusaurus.config.js b/packages/artplayer-document/docusaurus.config.js index 49cfb5451..990af6e7e 100644 --- a/packages/artplayer-document/docusaurus.config.js +++ b/packages/artplayer-document/docusaurus.config.js @@ -28,6 +28,7 @@ module.exports = { label: 'Github', }, { + href: '#', label: 'QQ群: 320881312', position: 'right', }, diff --git a/packages/artplayer-document/package.json b/packages/artplayer-document/package.json index 5634d4044..e254a7477 100644 --- a/packages/artplayer-document/package.json +++ b/packages/artplayer-document/package.json @@ -15,16 +15,16 @@ "write-heading-ids": "npx docusaurus write-heading-ids" }, "dependencies": { - "@docusaurus/core": "2.0.0-beta.3", - "@docusaurus/preset-classic": "2.0.0-beta.3", - "@mdx-js/react": "^1.6.21", + "@docusaurus/core": "2.0.0-beta.9", + "@docusaurus/preset-classic": "2.0.0-beta.9", + "@mdx-js/react": "^1.6.22", "@svgr/webpack": "^5.5.0", "clsx": "^1.1.1", - "docusaurus-lunr-search": "^2.1.14", + "docusaurus-lunr-search": "^2.1.15", "file-loader": "^6.2.0", "prism-react-renderer": "^1.2.1", - "react": "^17.0.1", - "react-dom": "^17.0.1", + "react": "^17.0.2", + "react-dom": "^17.0.2", "url-loader": "^4.1.1" }, "browserslist": { diff --git a/packages/artplayer-document/src/css/custom.css b/packages/artplayer-document/src/css/custom.css index 29d8472dd..576335bfa 100644 --- a/packages/artplayer-document/src/css/custom.css +++ b/packages/artplayer-document/src/css/custom.css @@ -58,3 +58,14 @@ table p { padding-left: 1rem; padding-left: var(--ifm-navbar-padding-horizontal); } + +.run-code { + display: inline-block; + padding: 3px 7px; + color: #fff; + border-radius: 3px; + background-color: #25c2a0; + margin-bottom: 10px; + font-size: 14px; + cursor: pointer; +} \ No newline at end of file diff --git a/packages/artplayer-document/src/script/bugfix.js b/packages/artplayer-document/src/script/bugfix.js index e69de29bb..3c82ce1ae 100644 --- a/packages/artplayer-document/src/script/bugfix.js +++ b/packages/artplayer-document/src/script/bugfix.js @@ -0,0 +1,12 @@ +document.addEventListener('click', (event) => { + if (event.target.className === 'run-code') { + event.preventDefault(); + const codeElement = event.target.nextElementSibling.querySelector('pre code'); + if (codeElement) { + const libs = event.target.dataset.libs || ''; + const code = encodeURIComponent(codeElement.innerText); + const url = 'https://artplayer.org/?libs=' + libs + '&code=' + code; + window.open(url); + } + } +});