This commit is contained in:
Harvey committed 2021-11-24 16:08:08 +08:00
1 parent 133a29ce6e
commit f25f97b3ac
90 files changed
+2694 -1133

No files matched your search

@@ -0,0 +1,61 @@
---
sidebar_position: 1
---
All other services can be used only after user
## Description
**Provider:** `Awda`
**Service url:** `/welab-sun/api/user/register`
**Dependency:** `NO`
**Request method** `POST`
## Request body
| Param | Type | Required | Description |
| ------- | ------ | -------- | ---------------------- |
| body | | Yes | |
| -mobile | String | Yes | Customer mobile number |
| -name | String | Yes | Customer name |
| -nik | String | Yes | Customer NIK |
| -email | String | Yes | Customer email |
Request Sample:
```json
{
"body":{
"email": "xxx",
"mobile": "xxx",
"name": "xxx",
"nik": "xxx"
},
"timestamp":"1488363493",
"signature":"B3C14758F4AF52AE8AA0D4CD1493B137",
"appId":"111",
"v":"1.0"
}
```
## Response (Json format)
| Param | Type | Required | Description |
| ------- | ------- | -------- | ------------ |
| code | Integer | Yes | Status code |
| message | String | Yes | Code message |
| result | Object | No | Return data |
Sample response for success request:
```json
{
"code":0,
"message":"Permintaan berhasil",
"result":null
}
```
@@ -0,0 +1,3 @@
---
sidebar_position: 10
---
@@ -0,0 +1,3 @@
---
sidebar_position: 11
---
@@ -0,0 +1,3 @@
---
sidebar_position: 12
---
@@ -0,0 +1,3 @@
---
sidebar_position: 13
---
@@ -0,0 +1,3 @@
---
sidebar_position: 14
---
@@ -0,0 +1,3 @@
---
sidebar_position: 15
---
@@ -0,0 +1,3 @@
---
sidebar_position: 16
---
@@ -0,0 +1,3 @@
---
sidebar_position: 17
---
@@ -0,0 +1,3 @@
---
sidebar_position: 18
---
@@ -0,0 +1,3 @@
---
sidebar_position: 2
---
@@ -0,0 +1,3 @@
---
sidebar_position: 3
---
@@ -0,0 +1,3 @@
---
sidebar_position: 4
---
@@ -0,0 +1,3 @@
---
sidebar_position: 5
---
@@ -0,0 +1,3 @@
---
sidebar_position: 6
---
@@ -0,0 +1,3 @@
---
sidebar_position: 7
---
@@ -0,0 +1,3 @@
---
sidebar_position: 8
---
@@ -0,0 +1,3 @@
---
sidebar_position: 9
---
@@ -0,0 +1,5 @@
{
"label": "Basic Services",
"position": 5,
"collapsed": false
}
@@ -0,0 +1,195 @@
---
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 | | |
@@ -0,0 +1,72 @@
---
title: Overview
sidebar_position: 1
slug: /
---
## Integration Guides
- Require confirmation from AWDA to implement to production after complete UAT for all services.
- You can use API tools to test some services during your development。
- You can check the response code or contact us when you have problems during the testing
- All services using POST method to send request(Including Inquiry)
- All requests and responses are JSON format. NOTE: Header Content-Type -> application/json UTF-8 encoding
- All requests require signature
## Document Change Control
| Version | Date | Authors | Summary of changes |
| ------- | ---------- | ------- | -------------------- |
| 1.0.0 | 2019.06.03 | ZHIBO | Thumbnails image url |
## API Summary
| **Service name** | **Description** |
| -----------------| --------------- |
| user registration| <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>|
| Authorization list inquiry| <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>|
| Get the authorization detail page| <p>Provider : AWDA</p><p>User : Third party </p><p>Mandatory : NO</p><p>Description : Customer complete the authorization in the pages</p>
| Call back for authorization status| <p>Provider : AWDA</p><p>User : Third party </p><p>Mandatory : NO</p><p>Description : To receive the authorization status</p>|
| Bank card inquiry| <p>Provider : AWDA</p><p>User : Third party </p><p>Mandatory : YES</p><p>Description : To inquiry bank card status</p>|
| Get bank list| <p>Provider : AWDA</p><p>User : Third party </p><p>Mandatory : YES</p><p>Description : Get the bank list for bank card input</p>|
| Bank card verification| <p>Provider : AWDA</p><p>User : Third party </p><p>Mandatory : YES</p><p>Description : Verify and submit bank card</p>|
| Submit loan| <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> |
| Loan agreement inquiry| <p>Provider : AWDA</p><p>User : Third party </p><p>Mandatory : YES</p><p>Description : Get loan agreement</p>|
| Sign agreement| <p>Provider : AWDA</p><p>User : Third party </p><p>Mandatory : YES</p><p>Description : Sign agreement (Confirm disbursement)</p>|
| Get loan information| <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> |
| Get repayment VA| <p>Provider : AWDA</p><p>User : Third party </p><p>Mandatory : YES</p><p>Description : Get the repayment VA</p>|
| Push notification| <p>Provider: Third party </p><p>User : AWDA</p><p>Mandatory: NO</p><p>Description : Push the loan status update to Third party </p>|
| Eligible Check| <p>Provider : AWDA</p><p>User : Third party </p><p>Mandatory : YES</p><p>Description : Verify Customer</p>|
| Get the token for uploading image| <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>|
| Upload Image (1)| <p>Provider : AWDA</p><p>User : Third party </p><p>Mandatory : NO</p><p>Description : By sending file stream with token</p>|
| Upload Image (2)| <p>Provider : AWDA</p><p>User : Third party </p><p>Mandatory : NO</p><p>Description : By sending base64 or url format</p>|
| Get the redirect url<br/>(For H5 pages of Digital Signature, Loan detail and Repayment detail) | <p>Provider : AWDA</p><p>User : Third party </p><p>Mandatory : NO</p><p>Description : Redirect to the specific H5 pages</p>|
## Environment information
- Testing environment:`https://sea-staging.wolaidai.com`
- Production environment:`https://japi.maucash.id`
- Note: All APIs URL will be environment `url` + `service url`
## List Of Response Code
| Code|Description|
| ----|----|
| 0 | Success|
| 1000| System is busy|
| 1001| Repeat request|
| 1002| Unvalid token|
| 1003| Timestamp error or expired (only valid within 60s)|
| 1004| Signature error|
| 1005| appId invalid|
| 1006| Parameters cannot be empty|
| 1007| Parameters error|
| 1008| User already existed|
| 1009| User not found|
| 1010| Loan not found|
| 1012| Authorization info not found|
@@ -0,0 +1,81 @@
---
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<String, Object> 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|<p>0: Success</p><p>Other codes all represent failure, find more details in Code List</p>|
| 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
}
}
```
@@ -0,0 +1,24 @@
---
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)