ArtPlayer/docs/document/zh-cn/index.html

<!doctype html>
<html lang="en" dir="ltr">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="generator" content="Docusaurus v2.0.0-beta.3">
<title data-react-helmet="true">前言 | Artplayer.js</title><meta data-react-helmet="true" property="og:url" content="https://artplayer.org/document/zh-cn"><meta data-react-helmet="true" name="docusaurus_locale" content="en"><meta data-react-helmet="true" name="docusaurus_version" content="current"><meta data-react-helmet="true" name="docusaurus_tag" content="docs-default-current"><meta data-react-helmet="true" property="og:title" content="前言 | Artplayer.js"><meta data-react-helmet="true" name="description" content="必读"><meta data-react-helmet="true" property="og:description" content="必读"><link data-react-helmet="true" rel="shortcut icon" href="/document/img/favicon.ico"><link data-react-helmet="true" rel="canonical" href="https://artplayer.org/document/zh-cn"><link data-react-helmet="true" rel="alternate" href="https://artplayer.org/document/zh-cn" hreflang="en"><link data-react-helmet="true" rel="alternate" href="https://artplayer.org/document/zh-cn" hreflang="x-default"><link rel="stylesheet" href="/document/assets/css/styles.1f01327e.css">
<link rel="preload" href="/document/assets/js/runtime~main.9213ef7f.js" as="script">
<link rel="preload" href="/document/assets/js/main.fedbd408.js" as="script">
</head>
<body>
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus">
<div><a href="#" class="skipToContent_2ebr">Skip to main content</a></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Navigation bar toggle" class="navbar__toggle clean-btn" type="button" tabindex="0"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/document/"><b class="navbar__title">Artplayer.js</b></a><a href="https://artplayer.org" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link"><span>Online Editor<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_3qag"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a><a href="https://github.com/zhw2590582/ArtPlayer" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link"><span>Github<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_3qag"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a></div><div class="navbar__items navbar__items--right"><a class="navbar__item navbar__link">QQ群: 320881312</a><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a class="navbar__item navbar__link">v 4.x.x</a><ul class="dropdown__menu"><li><a href="https://artplayer.org/document_v3/" target="_blank" rel="noopener noreferrer" class="dropdown__link"><span>v 3.x.x<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_3qag"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a></li></ul></div><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a class="navbar__item navbar__link">English</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/document/">English</a></li><li><a class="dropdown__link" href="/document/zh-cn/">中文</a></li></ul></div><div class="react-toggle displayOnlyInLargeViewport_PjS3 react-toggle--disabled"><div class="react-toggle-track" role="button" tabindex="-1"><div class="react-toggle-track-check"><span class="toggle_3k75">🌜</span></div><div class="react-toggle-track-x"><span class="toggle_3k75">🌞</span></div><div class="react-toggle-thumb"></div></div><input type="checkbox" class="react-toggle-screenreader-only" aria-label="Switch between dark and light mode"></div><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input type="search" id="search_input_react" placeholder="Search" aria-label="Search" class="navbar__search-input search-bar"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div><div class="navbar-sidebar"><div class="navbar-sidebar__brand"><a class="navbar__brand" href="/document/"><b class="navbar__title">Artplayer.js</b></a></div><div class="navbar-sidebar__items"><div class="menu"><ul class="menu__list"><li class="menu__list-item"><a href="https://artplayer.org" target="_blank" rel="noopener noreferrer" class="menu__link"><span>Online Editor<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_3qag"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a></li><li class="menu__list-item"><a href="https://github.com/zhw2590582/ArtPlayer" target="_blank" rel="noopener noreferrer" class="menu__link"><span>Github<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_3qag"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a></li><li class="menu__list-item"><a class="menu__link">QQ群: 320881312</a></li><li class="menu__list-item menu__list-item--collapsed"><a role="button" class="menu__link menu__link--sublist">v 4.x.x</a><ul class="menu__list"><li class="menu__list-item"><a href="https://artplayer.org/document_v3/" target="_blank" rel="noopener noreferrer" class="menu__link"><span>v 3.x.x<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_3qag"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a role="button" class="menu__link menu__link--sublist">English</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" href="/document/">English</a></li><li class="menu__list-item"><a class="menu__link" href="/document/zh-cn/">中文</a></li></ul></li></ul></div></div></div></nav><div class="main-wrapper docs-wrapper doc-page"><div class="docPage_2V9V"><aside class="docSidebarContainer_bKeA"><div class="sidebar_23hl"><nav class="menu menu--responsive thin-scrollbar menu_N163 menuWithAnnouncementBar_3kKv" aria-label="Sidebar navigation"><button aria-label="Open menu" aria-haspopup="true" class="button button--secondary button--sm menu__button" type="button"><svg class="sidebarMenuIcon_3IeT" width="24" height="24" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><ul class="menu__list"><li class="menu__list-item"><a aria-current="page" class="menu__link menu__link--active active" href="/document/zh-cn">前言</a></li><li class="menu__list-item"><a class="menu__link" href="/document/zh-cn/UML Diagram">参考对接UML时序图</a></li><li class="menu__list-item"><a class="menu__link" href="/document/zh-cn/Parameters Instructions">入参及出参说明</a></li><li class="menu__list-item"><a class="menu__link" href="/document/zh-cn/Data dictionary">数据字典</a></li><li class="menu__list-item"><a class="menu__link menu__link--sublist" href="#">基本接口</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/document/zh-cn/Basic Services/User Registration">用户创建</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/document/zh-cn/Basic Services/Authorization list inquiry">查询授权列表</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/document/zh-cn/Basic Services/Get the authorization detail page">获取授权地址</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/document/zh-cn/Basic Services/Call back for authorization status">授权回调通知</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/document/zh-cn/Basic Services/Bank card inquiry">绑卡信息查询</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/document/zh-cn/Basic Services/Get bank list">银行列表查询</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/document/zh-cn/Basic Services/Bank card verification">绑定银行卡</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/document/zh-cn/Basic Services/Submit loan">申请借款</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/document/zh-cn/Basic Services/Loan agreement inquiry">查看合同</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/document/zh-cn/Basic Services/Sign agreement">签约（确认放款）</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/document/zh-cn/Basic Services/Get loan information">贷款信息查询</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/document/zh-cn/Basic Services/Get repayment VA">用户还款虚拟账号查询</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/document/zh-cn/Basic Services/Push notification">推送通知</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/document/zh-cn/Basic Services/Eligible Check">Eligible Check</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/document/zh-cn/Basic Services/Get the token for uploading image">Get the token for uploading image</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/document/zh-cn/Basic Services/Upload Image - By sending file stream">Upload Image - By sending file stream</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/document/zh-cn/Basic Services/Upload Image - By using base64 or url format">Upload Image - By using base64 or url format</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/document/zh-cn/Basic Services/Get the redirect url">Get the redirect url</a></li></ul></li></ul></nav><button type="button" title="Collapse sidebar" aria-label="Collapse sidebar" class="button button--secondary button--outline collapseSidebarButton_2CWe"><svg width="20" height="20" aria-hidden="true" class="collapseSidebarButtonIcon_1YUG"><g fill="#7a7a7a"><path d="M9.992 10.023c0 .2-.062.399-.172.547l-4.996 7.492a.982.982 0 01-.828.454H1c-.55 0-1-.453-1-1 0-.2.059-.403.168-.551l4.629-6.942L.168 3.078A.939.939 0 010 2.528c0-.548.45-.997 1-.997h2.996c.352 0 .649.18.828.45L9.82 9.472c.11.148.172.347.172.55zm0 0"></path><path d="M19.98 10.023c0 .2-.058.399-.168.547l-4.996 7.492a.987.987 0 01-.828.454h-3c-.547 0-.996-.453-.996-1 0-.2.059-.403.168-.551l4.625-6.942-4.625-6.945a.939.939 0 01-.168-.55 1 1 0 01.996-.997h3c.348 0 .649.18.828.45l4.996 7.492c.11.148.168.347.168.55zm0 0"></path></g></svg></button></div></aside><main class="docMainContainer_J7Yc"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_fcm6"><div class="docItemContainer_2R9F"><article><div class="markdown"><header><h1 class="h1Heading_3OuH">前言</h1></header><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_1wgz" id="必读"></a>必读<a class="hash-link" href="#必读" title="Direct link to heading">#</a></h2><ul><li><p>在生产环境发布前前，请先通过测试环境调试完所有接口及流程后待我方确认无误方可上生产环境</p></li><li><p>在开发过程中，可以使用接口调试工具来在线调试某些接口。</p></li><li><p>在开发出现问题时，可以通过接口调用的返回码查看失败原因或联系我方技术支持人员</p></li><li><p>所有接口都采用POST方式（包括查询接口）</p></li><li><p>请求和响应的数据都为JSON格式。注：请设置Header的Content-Type为application/json，采用UTF-8字符编码</p></li><li><p>所有的接口必须进行接口签名</p></li></ul><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_1wgz" id="更新日志"></a>更新日志<a class="hash-link" href="#更新日志" title="Direct link to heading">#</a></h2><table><thead><tr><th>版本</th><th>日期</th><th>项目负责人</th><th>描述</th></tr></thead><tbody><tr><td>1.0.0</td><td>2019.06.03</td><td>吕志博</td><td>初始版本</td></tr></tbody></table><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_1wgz" id="接口说明"></a>接口说明<a class="hash-link" href="#接口说明" title="Direct link to heading">#</a></h2><table><thead><tr><th><strong>接口名称</strong></th><th><strong>描述</strong></th></tr></thead><tbody><tr><td>user registration</td><td><p>接口提供方: AWDA</p><p>接口调用方 : 合作方 </p><p>是否必须对接 : 是</p><p>接口描述 : 用户创建，必须先创建用户成功后才能调用其他接口</p></td></tr><tr><td>Authorization list inquiry</td><td><p>接口提供方: AWDA</p><p>接口调用方 : 合作方 </p><p>是否必须对接 : 否</p><p>接口描述 : 获取授权列表及用户个人授权状态</p></td></tr><tr><td>Get the authorization detail page</td><td><p>接口提供方: AWDA</p><p>接口调用方 : 合作方 </p><p>是否必须对接 : 否</p><p>接口描述 : 授权第三方授权页面地址</p></td></tr><tr><td>Call back for authorization status</td><td><p>接口提供方: AWDA</p><p>接口调用方 : 合作方 </p><p>是否必须对接 : 否</p><p>接口描述 : 通知授权结果</p></td></tr><tr><td>Bank card inquiry</td><td><p>接口提供方: AWDA</p><p>接口调用方 : 合作方 </p><p>是否必须对接 : 是</p><p>接口描述 : 查询绑卡信息</p></td></tr><tr><td>Get bank list</td><td><p>接口提供方: AWDA</p><p>接口调用方 : 合作方 </p><p>是否必须对接 : 是</p><p>接口描述 : 获取支持绑卡的银行列表</p></td></tr><tr><td>Bank card verification</td><td><p>接口提供方: AWDA</p><p>接口调用方 : 合作方 </p><p>是否必须对接 : 是</p><p>接口描述 : 用户绑定用于接收平台放款的银行卡</p></td></tr><tr><td>Submit loan</td><td><p>接口提供方: AWDA</p><p>接口调用方 : 合作方 </p><p>是否必须对接 : 是</p><p>接口描述 : 提交进件信息，进件信息包含（用户个人信息、身份信息、工作信息、紧急联系人信息）</p></td></tr><tr><td>Loan agreement inquiry</td><td><p>接口提供方: AWDA</p><p>接口调用方 : 合作方 </p><p>是否必须对接 : 是</p><p>接口描述 : 查看贷款合同</p></td></tr><tr><td>Sign agreement</td><td><p>接口提供方: AWDA</p><p>接口调用方 : 合作方 </p><p>是否必须对接 : 是</p><p>接口描述 : 合同签约（确认放款）</p></td></tr><tr><td>Get loan information</td><td><p>接口提供方: AWDA</p><p>接口调用方 : 合作方 </p><p>是否必须对接 : 是</p><p>接口描述 : 根据贷款编号查询贷款当前信息（如已放款则包含还款计划）</p></td></tr><tr><td>Get repayment VA</td><td><p>接口提供方: AWDA</p><p>接口调用方 : 合作方 </p><p>是否必须对接 : 是</p><p>接口描述 : 用户还款虚拟账号查询</p></td></tr><tr><td>Push notification</td><td><p>Provider: Third party </p><p>User : AWDA</p><p>是否必须对接: 否</p><p>接口描述 : 推送贷款状态变更消息</p></td></tr><tr><td>Eligible Check</td><td><p>接口提供方: AWDA</p><p>接口调用方 : 合作方 </p><p>是否必须对接 : 是</p><p>接口描述 : Verify Customer</p></td></tr><tr><td>Get the token for uploading image</td><td><p>接口提供方: AWDA</p><p>接口调用方 : 合作方 </p><p>是否必须对接 : 否</p><p>接口描述 : To get the token which used for api Upload Image (1)</p></td></tr><tr><td>Upload Image (1)</td><td><p>接口提供方: AWDA</p><p>接口调用方 : 合作方 </p><p>是否必须对接 : 否</p><p>接口描述 : By sending file stream with token</p></td></tr><tr><td>Upload Image (2)</td><td><p>接口提供方: AWDA</p><p>接口调用方 : 合作方 </p><p>是否必须对接 : 否</p><p>接口描述 : By sending base64 or url format</p></td></tr><tr><td>Get the redirect url<br>(For H5 pages of Digital Signature, Loan detail and Repayment detail)</td><td><p>接口提供方: AWDA</p><p>接口调用方 : 合作方 </p><p>是否必须对接 : 否</p><p>接口描述 : Redirect to the specific H5 pages</p></td></tr></tbody></table><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_1wgz" id="环境地址说明"></a>环境地址说明<a class="hash-link" href="#环境地址说明" title="Direct link to heading">#</a></h2><p>测试环境域名：<code>https://sea-staging.wolaidai.com</code></p><p>生产环境域名：<code>https://japi.maucash.id</code></p><p>注：所有接口调用真实地址为 <code>环境域名+接口地址</code></p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_1wgz" id="全局状态码说明"></a>全局状态码说明<a class="hash-link" href="#全局状态码说明" title="Direct link to heading">#</a></h2><table><thead><tr><th>返回码</th><th>描述</th></tr></thead><tbody><tr><td>0</td><td>请求成功</td></tr><tr><td>100</td><td>系统繁忙</td></tr><tr><td>300</td><td>请求超时</td></tr><tr><td>400</td><td>参数错误</td></tr><tr><td>404</td><td>网络异常</td></tr><tr><td>600</td><td>数据不存在</td></tr><tr><td>999</td><td>其他未知错误</td></tr><tr><td>1001</td><td>重复请求</td></tr><tr><td>1002</td><td>无效的token</td></tr><tr><td>1003</td><td>时间戳有误或已失效（仅处理60S内的请求）</td></tr><tr><td>1004</td><td>签名校验不通过</td></tr><tr><td>1005</td><td>商户号错误</td></tr><tr><td>1006</td><td>参数不能为空</td></tr><tr><td>1007</td><td>参数有误</td></tr><tr><td>1008</td><td>用户已存在</td></tr><tr><td>1009</td><td>用户不存在</td></tr><tr><td>1010</td><td>订单不存在</td></tr><tr><td>1011</td><td>系统繁忙</td></tr><tr><td>1012</td><td>授权信息获取失败</td></tr></tbody></table></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><div class="pagination-nav__item"></div><div class="pagination-nav__item pagination-nav__item--next"><a class="pagination-nav__link" href="/document/zh-cn/UML Diagram"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">参考对接UML时序图 »</div></a></div></nav></div></div><div class="col col--3"><div class="tableOfContents_23zS thin-scrollbar"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#必读" class="table-of-contents__link">必读</a></li><li><a href="#更新日志" class="table-of-contents__link">更新日志</a></li><li><a href="#接口说明" class="table-of-contents__link">接口说明</a></li><li><a href="#环境地址说明" class="table-of-contents__link">环境地址说明</a></li><li><a href="#全局状态码说明" class="table-of-contents__link">全局状态码说明</a></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2021 Artplayer.js, Inc. Built with Docusaurus.</div></div></div></footer></div>
<script src="/document/assets/js/runtime~main.9213ef7f.js"></script>
<script src="/document/assets/js/main.fedbd408.js"></script>
</body>
</html>