Files
ArtPlayer/docs/document/index.html
T
2021-11-24 16:50:48 +08:00

17 lines
20 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!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">Overview | Artplayer.js</title><meta data-react-helmet="true" property="og:url" content="https://artplayer.org/document/"><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="Overview | Artplayer.js"><meta data-react-helmet="true" name="description" content="Integration Guides"><meta data-react-helmet="true" property="og:description" content="Integration Guides"><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/"><link data-react-helmet="true" rel="alternate" href="https://artplayer.org/document/" hreflang="en"><link data-react-helmet="true" rel="alternate" href="https://artplayer.org/document/" hreflang="x-default"><script data-react-helmet="true">function maybeInsertBanner(){window.__DOCUSAURUS_INSERT_BASEURL_BANNER&&insertBanner()}function insertBanner(){var n=document.getElementById("docusaurus-base-url-issue-banner-container");if(n){n.innerHTML='\n<div id="docusaurus-base-url-issue-banner" style="border: thick solid red; background-color: rgb(255, 230, 179); margin: 20px; padding: 20px; font-size: 20px;">\n <p style="font-weight: bold; font-size: 30px;">Your Docusaurus site did not load properly.</p>\n <p>A very common reason is a wrong site <a href="https://docusaurus.io/docs/docusaurus.config.js/#baseurl" style="font-weight: bold;">baseUrl configuration</a>.</p>\n <p>Current configured baseUrl = <span style="font-weight: bold; color: red;">/document/</span> </p>\n <p>We suggest trying baseUrl = <span id="docusaurus-base-url-issue-banner-suggestion-container" style="font-weight: bold; color: green;"></span></p>\n</div>\n';var e=document.getElementById("docusaurus-base-url-issue-banner-suggestion-container"),s=window.location.pathname,r="/"===s.substr(-1)?s:s+"/";e.innerHTML=r}}window.__DOCUSAURUS_INSERT_BASEURL_BANNER=!0,document.addEventListener("DOMContentLoaded",maybeInsertBanner)</script><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 id="docusaurus-base-url-issue-banner-container"></div><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/">Overview</a></li><li class="menu__list-item"><a class="menu__link" href="/document/en/UML Diagram">UML Diagram</a></li><li class="menu__list-item"><a class="menu__link" href="/document/en/Parameters Instructions">Parameters Instructions</a></li><li class="menu__list-item"><a class="menu__link" href="/document/en/Data dictionary">Data dictionary</a></li><li class="menu__list-item"><a class="menu__link menu__link--sublist" href="#">Basic Services</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/document/en/Basic Services/User Registration">User Registration</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/document/en/Basic Services/Authorization list inquiry">Authorization list inquiry</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/document/en/Basic Services/Get the authorization detail page">Get the authorization detail page</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/document/en/Basic Services/Call back for authorization status">Call back for authorization status</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/document/en/Basic Services/Bank card inquiry">Bank card inquiry</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/document/en/Basic Services/Get bank list">Get bank list</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/document/en/Basic Services/Bank card verification">Bank card verification</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/document/en/Basic Services/Submit loan">Submit loan</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/document/en/Basic Services/Loan agreement inquiry">Loan agreement inquiry</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/document/en/Basic Services/Sign agreement">Sign agreement</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/document/en/Basic Services/Get loan information">Get loan information</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/document/en/Basic Services/Get repayment VA">Get repayment VA</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/document/en/Basic Services/Push notification">Push notification</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/document/en/Basic Services/Eligible Check">Eligible Check</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/document/en/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/en/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/en/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/en/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">Overview</h1></header><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_1wgz" id="integration-guides"></a>Integration Guides<a class="hash-link" href="#integration-guides" title="Direct link to heading">#</a></h2><ul><li><p>Require confirmation from AWDA to implement to production after complete UAT for all services.</p></li><li><p>You can use API tools to test some services during your development。</p></li><li><p>You can check the response code or contact us when you have problems during the testing</p></li><li><p>All services using POST method to send request(Including Inquiry)</p></li><li><p>All requests and responses are JSON format. NOTE: Header Content-Type -&gt; application/json UTF-8 encoding</p></li><li><p>All requests require signature</p></li></ul><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_1wgz" id="document-change-control"></a>Document Change Control<a class="hash-link" href="#document-change-control" title="Direct link to heading">#</a></h2><table><thead><tr><th>Version</th><th>Date</th><th>Authors</th><th>Summary of changes</th></tr></thead><tbody><tr><td>1.0.0</td><td>2019.06.03</td><td>ZHIBO</td><td>Thumbnails image url</td></tr></tbody></table><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_1wgz" id="api-summary"></a>API Summary<a class="hash-link" href="#api-summary" title="Direct link to heading">#</a></h2><table><thead><tr><th><strong>Service name</strong></th><th><strong>Description</strong></th></tr></thead><tbody><tr><td>user registration</td><td><p>Provider : AWDA</p><p>User : Third party </p><p>Mandatory : YES</p><p>Description : All other services can be used only after user registration success</p></td></tr><tr><td>Authorization list inquiry</td><td><p>Provider : AWDA</p><p>User : Third party </p><p>Mandatory : NO</p><p>Description : Get the authorization list and check the authorization status</p></td></tr><tr><td>Get the authorization detail page</td><td><p>Provider : AWDA</p><p>User : Third party </p><p>Mandatory : NO</p><p>Description : Customer complete the authorization in the pages</p></td></tr><tr><td>Call back for authorization status</td><td><p>Provider : AWDA</p><p>User : Third party </p><p>Mandatory : NO</p><p>Description : To receive the authorization status</p></td></tr><tr><td>Bank card inquiry</td><td><p>Provider : AWDA</p><p>User : Third party </p><p>Mandatory : YES</p><p>Description : To inquiry bank card status</p></td></tr><tr><td>Get bank list</td><td><p>Provider : AWDA</p><p>User : Third party </p><p>Mandatory : YES</p><p>Description : Get the bank list for bank card input</p></td></tr><tr><td>Bank card verification</td><td><p>Provider : AWDA</p><p>User : Third party </p><p>Mandatory : YES</p><p>Description : Verify and submit bank card</p></td></tr><tr><td>Submit loan</td><td><p>Provider : AWDA</p><p>User : Third party </p><p>Mandatory : YES</p><p>Description : Submit loan info, including (personal info, work info and emergency contact)</p></td></tr><tr><td>Loan agreement inquiry</td><td><p>Provider : AWDA</p><p>User : Third party </p><p>Mandatory : YES</p><p>Description : Get loan agreement</p></td></tr><tr><td>Sign agreement</td><td><p>Provider : AWDA</p><p>User : Third party </p><p>Mandatory : YES</p><p>Description : Sign agreement (Confirm disbursement)</p></td></tr><tr><td>Get loan information</td><td><p>Provider : AWDA</p><p>User : Third party </p><p>Mandatory : YES</p><p>Description : Get loan info based on loan number (include repayment schedule if disbursed)</p></td></tr><tr><td>Get repayment VA</td><td><p>Provider : AWDA</p><p>User : Third party </p><p>Mandatory : YES</p><p>Description : Get the repayment VA</p></td></tr><tr><td>Push notification</td><td><p>Provider: Third party </p><p>User : AWDA</p><p>Mandatory: NO</p><p>Description : Push the loan status update to Third party </p></td></tr><tr><td>Eligible Check</td><td><p>Provider : AWDA</p><p>User : Third party </p><p>Mandatory : YES</p><p>Description : Verify Customer</p></td></tr><tr><td>Get the token for uploading image</td><td><p>Provider : AWDA</p><p>User : Third party </p><p>Mandatory : NO</p><p>Description : To get the token which used for api Upload Image (1)</p></td></tr><tr><td>Upload Image (1)</td><td><p>Provider : AWDA</p><p>User : Third party </p><p>Mandatory : NO</p><p>Description : By sending file stream with token</p></td></tr><tr><td>Upload Image (2)</td><td><p>Provider : AWDA</p><p>User : Third party </p><p>Mandatory : NO</p><p>Description : 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>Provider : AWDA</p><p>User : Third party </p><p>Mandatory : NO</p><p>Description : Redirect to the specific H5 pages</p></td></tr></tbody></table><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_1wgz" id="environment-information"></a>Environment information<a class="hash-link" href="#environment-information" title="Direct link to heading">#</a></h2><ul><li>Testing environment:<code>https://sea-staging.wolaidai.com</code></li><li>Production environment:<code>https://japi.maucash.id</code></li><li>Note: All APIs URL will be environment <code>url</code> + <code>service url</code></li></ul><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_1wgz" id="list-of-response-code"></a>List Of Response Code<a class="hash-link" href="#list-of-response-code" title="Direct link to heading">#</a></h2><table><thead><tr><th>Code</th><th>Description</th></tr></thead><tbody><tr><td>0</td><td>Success</td></tr><tr><td>1000</td><td>System is busy</td></tr><tr><td>1001</td><td>Repeat request</td></tr><tr><td>1002</td><td>Unvalid token</td></tr><tr><td>1003</td><td>Timestamp error or expired (only valid within 60s)</td></tr><tr><td>1004</td><td>Signature error</td></tr><tr><td>1005</td><td>appId invalid</td></tr><tr><td>1006</td><td>Parameters cannot be empty</td></tr><tr><td>1007</td><td>Parameters error</td></tr><tr><td>1008</td><td>User already existed</td></tr><tr><td>1009</td><td>User not found</td></tr><tr><td>1010</td><td>Loan not found</td></tr><tr><td>1012</td><td>Authorization info not found</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/en/UML Diagram"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">UML Diagram »</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="#integration-guides" class="table-of-contents__link">Integration Guides</a></li><li><a href="#document-change-control" class="table-of-contents__link">Document Change Control</a></li><li><a href="#api-summary" class="table-of-contents__link">API Summary</a></li><li><a href="#environment-information" class="table-of-contents__link">Environment information</a></li><li><a href="#list-of-response-code" class="table-of-contents__link">List Of Response Code</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>