ArtPlayer/docs/document/assets/js/0a29ddce.220313c9.js

(self.webpackChunkartplayer_document=self.webpackChunkartplayer_document||[]).push([[9176],{9278:function(t,e,n){"use strict";n.d(e,{Zo:function(){return d},kt:function(){return s}});var r=n(9301);function a(t,e,n){return e in t?Object.defineProperty(t,e,{value:n,enumerable:!0,configurable:!0,writable:!0}):t[e]=n,t}function l(t,e){var n=Object.keys(t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(t);e&&(r=r.filter((function(e){return Object.getOwnPropertyDescriptor(t,e).enumerable}))),n.push.apply(n,r)}return n}function i(t){for(var e=1;e<arguments.length;e++){var n=null!=arguments[e]?arguments[e]:{};e%2?l(Object(n),!0).forEach((function(e){a(t,e,n[e])})):Object.getOwnPropertyDescriptors?Object.defineProperties(t,Object.getOwnPropertyDescriptors(n)):l(Object(n)).forEach((function(e){Object.defineProperty(t,e,Object.getOwnPropertyDescriptor(n,e))}))}return t}function o(t,e){if(null==t)return{};var n,r,a=function(t,e){if(null==t)return{};var n,r,a={},l=Object.keys(t);for(r=0;r<l.length;r++)n=l[r],e.indexOf(n)>=0||(a[n]=t[n]);return a}(t,e);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(t);for(r=0;r<l.length;r++)n=l[r],e.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(t,n)&&(a[n]=t[n])}return a}var p=r.createContext({}),u=function(t){var e=r.useContext(p),n=e;return t&&(n="function"==typeof t?t(e):i(i({},e),t)),n},d=function(t){var e=u(t.components);return r.createElement(p.Provider,{value:e},t.children)},m={inlineCode:"code",wrapper:function(t){var e=t.children;return r.createElement(r.Fragment,{},e)}},k=r.forwardRef((function(t,e){var n=t.components,a=t.mdxType,l=t.originalType,p=t.parentName,d=o(t,["components","mdxType","originalType","parentName"]),k=u(n),s=a,c=k["".concat(p,".").concat(s)]||k[s]||m[s]||l;return n?r.createElement(c,i(i({ref:e},d),{},{components:n})):r.createElement(c,i({ref:e},d))}));function s(t,e){var n=arguments,a=e&&e.mdxType;if("string"==typeof t||a){var l=n.length,i=new Array(l);i[0]=k;var o={};for(var p in e)hasOwnProperty.call(e,p)&&(o[p]=e[p]);o.originalType=t,o.mdxType="string"==typeof t?t:a,i[1]=o;for(var u=2;u<l;u++)i[u]=n[u];return r.createElement.apply(null,i)}return r.createElement.apply(null,n)}k.displayName="MDXCreateElement"},7598:function(t,e,n){"use strict";n.r(e),n.d(e,{frontMatter:function(){return o},contentTitle:function(){return p},metadata:function(){return u},toc:function(){return d},default:function(){return k}});var r=n(1814),a=n(7256),l=(n(9301),n(9278)),i=["components"],o={title:"Overview",sidebar_position:1,slug:"/"},p=void 0,u={unversionedId:"en/Overview",id:"en/Overview",isDocsHomePage:!1,title:"Overview",description:"Integration Guides",source:"@site/docs/en/Overview.md",sourceDirName:"en",slug:"/",permalink:"/document/",version:"current",sidebarPosition:1,frontMatter:{title:"Overview",sidebar_position:1,slug:"/"},sidebar:"en",next:{title:"UML Diagram",permalink:"/document/en/UML Diagram"}},d=[{value:"Integration Guides",id:"integration-guides",children:[]},{value:"Document Change Control",id:"document-change-control",children:[]},{value:"API Summary",id:"api-summary",children:[]},{value:"Environment information",id:"environment-information",children:[]},{value:"List Of Response Code",id:"list-of-response-code",children:[]}],m={toc:d};function k(t){var e=t.components,n=(0,a.Z)(t,i);return(0,l.kt)("wrapper",(0,r.Z)({},m,n,{components:e,mdxType:"MDXLayout"}),(0,l.kt)("h2",{id:"integration-guides"},"Integration Guides"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("p",{parentName:"li"},"Require confirmation from AWDA to implement to production after complete UAT for all services.")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("p",{parentName:"li"},"You can use API tools to test some services during your development\u3002")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("p",{parentName:"li"},"You can check the response code or contact us when you have problems during the testing")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("p",{parentName:"li"},"All services using POST method to send request\uff08Including Inquiry\uff09")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("p",{parentName:"li"},"All requests and responses are JSON format. NOTE: Header Content-Type -> application/json UTF-8 encoding")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("p",{parentName:"li"},"All requests require signature"))),(0,l.kt)("h2",{id:"document-change-control"},"Document Change Control"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Version"),(0,l.kt)("th",{parentName:"tr",align:null},"Date"),(0,l.kt)("th",{parentName:"tr",align:null},"Authors"),(0,l.kt)("th",{parentName:"tr",align:null},"Summary of changes"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"1.0.0"),(0,l.kt)("td",{parentName:"tr",align:null},"2019.06.03"),(0,l.kt)("td",{parentName:"tr",align:null},"ZHIBO"),(0,l.kt)("td",{parentName:"tr",align:null},"Thumbnails image url")))),(0,l.kt)("h2",{id:"api-summary"},"API Summary"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},(0,l.kt)("strong",{parentName:"th"},"Service name")),(0,l.kt)("th",{parentName:"tr",align:null},(0,l.kt)("strong",{parentName:"th"},"Description")))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"user registration"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("p",null,"Provider : AWDA"),(0,l.kt)("p",null,"User : Third party "),(0,l.kt)("p",null,"Mandatory : YES"),(0,l.kt)("p",null,"Description : All other services can be used only after user registration success"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Authorization list inquiry"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("p",null,"Provider : AWDA"),(0,l.kt)("p",null,"User : Third party "),(0,l.kt)("p",null,"Mandatory : NO"),(0,l.kt)("p",null,"Description : Get the authorization list and check the authorization status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Get the authorization detail page"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("p",null,"Provider : AWDA"),(0,l.kt)("p",null,"User : Third party "),(0,l.kt)("p",null,"Mandatory : NO"),(0,l.kt)("p",null,"Description : Customer complete the authorization in the pages"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Call back for authorization status"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("p",null,"Provider : AWDA"),(0,l.kt)("p",null,"User : Third party "),(0,l.kt)("p",null,"Mandatory : NO"),(0,l.kt)("p",null,"Description : To receive the authorization status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Bank card inquiry"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("p",null,"Provider : AWDA"),(0,l.kt)("p",null,"User : Third party "),(0,l.kt)("p",null,"Mandatory : YES"),(0,l.kt)("p",null,"Description : To inquiry bank card status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Get bank list"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("p",null,"Provider : AWDA"),(0,l.kt)("p",null,"User : Third party "),(0,l.kt)("p",null,"Mandatory : YES"),(0,l.kt)("p",null,"Description : Get the bank list for bank card input"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Bank card verification"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("p",null,"Provider : AWDA"),(0,l.kt)("p",null,"User : Third party "),(0,l.kt)("p",null,"Mandatory : YES"),(0,l.kt)("p",null,"Description : Verify and submit bank card"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Submit loan"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("p",null,"Provider : AWDA"),(0,l.kt)("p",null,"User : Third party "),(0,l.kt)("p",null,"Mandatory : YES"),(0,l.kt)("p",null,"Description : Submit loan info, including (personal info, work info and emergency contact)"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Loan agreement inquiry"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("p",null,"Provider : AWDA"),(0,l.kt)("p",null,"User : Third party "),(0,l.kt)("p",null,"Mandatory : YES"),(0,l.kt)("p",null,"Description : Get loan agreement"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Sign agreement"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("p",null,"Provider : AWDA"),(0,l.kt)("p",null,"User : Third party "),(0,l.kt)("p",null,"Mandatory : YES"),(0,l.kt)("p",null,"Description : Sign agreement (Confirm disbursement)"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Get loan information"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("p",null,"Provider : AWDA"),(0,l.kt)("p",null,"User : Third party "),(0,l.kt)("p",null,"Mandatory : YES"),(0,l.kt)("p",null,"Description : Get loan info based on loan number (include repayment schedule if disbursed)"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Get repayment VA"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("p",null,"Provider : AWDA"),(0,l.kt)("p",null,"User : Third party "),(0,l.kt)("p",null,"Mandatory : YES"),(0,l.kt)("p",null,"Description : Get the repayment VA"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Push notification"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("p",null,"Provider: Third party "),(0,l.kt)("p",null,"User : AWDA"),(0,l.kt)("p",null,"Mandatory: NO"),(0,l.kt)("p",null,"Description : Push the loan status update to Third party "))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Eligible Check"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("p",null,"Provider : AWDA"),(0,l.kt)("p",null,"User : Third party "),(0,l.kt)("p",null,"Mandatory : YES"),(0,l.kt)("p",null,"Description : Verify Customer"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Get the token for uploading image"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("p",null,"Provider : AWDA"),(0,l.kt)("p",null,"User : Third party "),(0,l.kt)("p",null,"Mandatory : NO"),(0,l.kt)("p",null,"Description : To get the token which used for api Upload Image (1)"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Upload Image (1)"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("p",null,"Provider : AWDA"),(0,l.kt)("p",null,"User : Third party "),(0,l.kt)("p",null,"Mandatory : NO"),(0,l.kt)("p",null,"Description : By sending file stream with token"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Upload Image (2)"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("p",null,"Provider : AWDA"),(0,l.kt)("p",null,"User : Third party "),(0,l.kt)("p",null,"Mandatory : NO"),(0,l.kt)("p",null,"Description : By sending base64 or url format"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Get the redirect url",(0,l.kt)("br",null),"(For H5 pages of Digital Signature, Loan detail and Repayment detail)"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("p",null,"Provider : AWDA"),(0,l.kt)("p",null,"User : Third party "),(0,l.kt)("p",null,"Mandatory : NO"),(0,l.kt)("p",null,"Description : Redirect to the specific H5 pages"))))),(0,l.kt)("h2",{id:"environment-information"},"Environment information"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},"Testing environment\uff1a",(0,l.kt)("inlineCode",{parentName:"li"},"https://sea-staging.wolaidai.com")),(0,l.kt)("li",{parentName:"ul"},"Production environment\uff1a",(0,l.kt)("inlineCode",{parentName:"li"},"https://japi.maucash.id")),(0,l.kt)("li",{parentName:"ul"},"Note: All APIs URL will be environment ",(0,l.kt)("inlineCode",{parentName:"li"},"url")," + ",(0,l.kt)("inlineCode",{parentName:"li"},"service url"))),(0,l.kt)("h2",{id:"list-of-response-code"},"List Of Response Code"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"0"),(0,l.kt)("td",{parentName:"tr",align:null},"Success")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"1000"),(0,l.kt)("td",{parentName:"tr",align:null},"System is busy")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"1001"),(0,l.kt)("td",{parentName:"tr",align:null},"Repeat request")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"1002"),(0,l.kt)("td",{parentName:"tr",align:null},"Unvalid token")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"1003"),(0,l.kt)("td",{parentName:"tr",align:null},"Timestamp error or expired (only valid within 60s)")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"1004"),(0,l.kt)("td",{parentName:"tr",align:null},"Signature error")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"1005"),(0,l.kt)("td",{parentName:"tr",align:null},"appId invalid")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"1006"),(0,l.kt)("td",{parentName:"tr",align:null},"Parameters cannot be empty")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"1007"),(0,l.kt)("td",{parentName:"tr",align:null},"Parameters error")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"1008"),(0,l.kt)("td",{parentName:"tr",align:null},"User already existed")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"1009"),(0,l.kt)("td",{parentName:"tr",align:null},"User not found")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"1010"),(0,l.kt)("td",{parentName:"tr",align:null},"Loan not found")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"1012"),(0,l.kt)("td",{parentName:"tr",align:null},"Authorization info not found")))))}k.isMDXComponent=!0}}]);