https://github.com/revenuemonster/rm-go-sdk
Revenue Monster SDK
https://github.com/revenuemonster/rm-go-sdk
go rm rm-sdk
Last synced: 12 months ago
JSON representation
Revenue Monster SDK
- Host: GitHub
- URL: https://github.com/revenuemonster/rm-go-sdk
- Owner: RevenueMonster
- Created: 2019-01-14T02:56:54.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-11-22T05:57:32.000Z (over 1 year ago)
- Last Synced: 2024-11-22T06:28:00.658Z (over 1 year ago)
- Topics: go, rm, rm-sdk
- Language: Go
- Homepage:
- Size: 205 KB
- Stars: 3
- Watchers: 4
- Forks: 12
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# API-SDK-Go
This is an Go SDK that maps some of the RESTful methods of Open API that are documented at [doc.revenuemonster.my](https://doc.revenuemonster.my/).
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
The golang version 1.11 and above
### Covered Functions
- [x] Signature Algorithm
- [x] Client Credentials (Authentication)
- [x] Refresh Token (Authentication)
- [ ] Get Merchant Profile
- [x] Get Merchant Subscriptions
- [x] Get Stores
- [ ] Get Stores By ID
- [ ] Create Store
- [ ] Update Store
- [ ] Delete Store
- [x] Get User Profile
- [x] Payment (Transaction QR) - Create Transaction QRCode/URL
- [] Payment (Transaction QR) - Get Transaction QRCode/URL
- [x] Payment (Transaction QR) - Get Transaction QRCode/URL By Code
- [x] Payment (Transaction QR) - Get Transactions By Code
- [x] Payment (Quick Pay) - Payment
- [x] Payment (Quick Pay) - Refund
- [x] Payment (Quick Pay) - Reverse
- [ ] Payment (Quick Pay) - Get All Payment Transactions
- [x] Payment (Quick Pay) - Get All Payment Transaction By ID
- [] Payment (Quick Pay) - Get All Payment Transaction By OrderID
- [ ] Payment (Quick Pay) - Daily Settlement Report
- [x] Register Loyalty Member
- [ ] Give Loyalty Point
- [ ] Get Loyalty Members
- [x] Get Loyalty Member
- [ ] Get Loyalty Member Point History
- [ ] Issue Voucher
- [ ] Void Voucher
- [x] Get Voucher By Code
- [x] Get Voucher Batches
- [x] Get Voucher Batch By Key
- [ ] Send Notification (Merchant)
- [x] Send Notification (Store)
- [ ] Send Notification (User)
- [x] Sms Sending
- [x] Create Delivery
- [x] Get Delivery By Id
- [x] Calculate Delivery Fee
- [x] Ekyc - MyKad Recognition
- [x] EKyc - Face Comparison
- [x] Ekyc - Liveness Verification
### Usage
1. "sandbox" is for sandbox environment.
2. "production" is for production environment.
3. Get Client ID and Client Secret from portal.
4. Generate private key and publci key from portal.
5. Store private key for own use and public key at portal.
6. Set environment variables at begining of the project before using any of the library functions.
```
Environment environment = new Environment();
environment.setEnvironment(clientId, clientSecret, "sandbox");
```
* Sample to read private key file
```
```
* Client Credentials (Authentication)
* To get refresh token and access token(expired after 2 hours) with using provided clientId and clientSecret
```
```
* Authorization Code (Authentication)
* To get authorization code which a partner wants to request permission to develop an application of a merchant and exchange authorization code into access token and refresh token
```go
oauthURL := sdk.NewClient(sdk.Client{
ID: "123456789",
Secret: "123456789",
IsSandbox: true,
PrivateKey: []byte(`---private key---`),
PublicKey: []byte(`---public key---`),
}).GetAuthorizationCodeURL(
"123456789",
"http://google.com",
"manage_payment",
"manage_store",
)
```
* Refresh Token (Authentication)
* To get new access token(expired after 2 hours) with using provided clientId and clientSecret (recommended to schedule to run this fucntion on every less than 2 hours) in order to avoid expired access token error
```
```
* Create Transaction QRCode/URL (TransactionQR)
* To create static/dynamic QR code for user scanning merchant's displayed QR
```
```
* Get Transaction QRCode/URL (TransactionQR)
* To get all QR Code(s) generated previously in the system
```
```
* Get Transaction QRCode/URL By Code (TransactionQR)
* To get specific QR Code generated previously in the system, by passing in code in query parameter (/qrcode/...)
```
```
* Get Transactions By Code (TransactionQR)
* To get all transactions under existing QR code, by passing in code in query parameter (/qrcode/.../transactions)
```
```
* Payment (Quick Pay) - Payment
* To make payment by scanning barcode/authcode from user
```
```
* Payment (Quick Pay) - Refund
* To refund the successful transactions
```
```
* Payment (Quick Pay) - Reverse
* To reverse time-out or problematic transaction
```
```
* Payment (Quick Pay) - Get Payment Transaction By ID
* To get details of a transaction by using transactionId
```
```
* Payment (Quick Pay) - Get Payment Transaction By Order ID
* To get details of a transaction by using orderId
```
```
* Push Notification ( Store ) - Send Notificaiton To Store By Store ID
```go
sdk.NewClient(sdk.Client{
ID: "123456789",
Secret: "123456789",
IsSandbox: true,
PrivateKey: []byte(`---private key---`),
PublicKey: []byte(`---public key---`),
}).PushNotificationToStore(sdk.RequestPushNotificationToStore{
StoreID: "123123123",
Title: "Notification Title",
Body: "Notification Body",
})
```
* Sms Sending - Send Sms To Specified Phone Number
```go
sdk.NewClient(sdk.Client{
ID: "123456789",
Secret: "123456789",
IsSandbox: true,
PrivateKey: []byte(`---private key---`),
PublicKey: []byte(`---public key---`),
}).SendSms(sdk.RequestSendSms{
CountryCode: "60",
PhoneNumber: "187824152",
Message: "Some message",
Type: sdk.MessageTypeTAC,
})
```
* Create Delivery - Create delivery
```go
pointOne := sdk.DeliveryPoint{
Address: "",
EntraceNumber: "",
FloorNumber: "",
BuildingNumber: "",
Remark: "",
Contact: sdk.DeliveryPointContact{
Name: "",
PhoneNumber: "",
},
}
pointTwo := sdk.DeliveryPoint{
Address: "",
EntraceNumber: "",
FloorNumber: "",
BuildingNumber: "",
Remark: "",
Contact: sdk.DeliveryPointContact{
Name: "",
PhoneNumber: "",
},
}
sdk.NewClient(sdk.Client{
ID: "123456789",
Secret: "123456789",
IsSandbox: true,
PrivateKey: []byte(`---private key---`),
PublicKey: []byte(`---public key---`),
}).CreateDelivery(sdk.RequestCreateDelivery{
DeliveryVendor: sdk.DeliveryVendor{
Vendor: sdk.VendorTypeMrSpeedy,
Credential: "",
},
VehicleType: sdk.VehicleTypeMotobike,
Type: sdk.DeliveryTypeDocument,
IsCashAccount: true,
Points: []sdk.DeliveryContact{pointOne, pointTwo},
})
```
* Calculate Delivery Fee - Calculate delivery fee before delivery is made
```go
pointOne := sdk.DeliveryPoint{
Address: "",
EntraceNumber: "",
FloorNumber: "",
BuildingNumber: "",
Remark: "",
Contact: sdk.DeliveryPointContact{
Name: "",
PhoneNumber: "",
},
}
pointTwo := sdk.DeliveryPoint{
Address: "",
EntraceNumber: "",
FloorNumber: "",
BuildingNumber: "",
Remark: "",
Contact: sdk.DeliveryPointContact{
Name: "",
PhoneNumber: "",
},
}
sdk.NewClient(sdk.Client{
ID: "123456789",
Secret: "123456789",
IsSandbox: true,
PrivateKey: []byte(`---private key---`),
PublicKey: []byte(`---public key---`),
}).CalculateDeliveryFee(sdk.RequestCalculateDeliveryFee{
DeliveryVendor: sdk.DeliveryVendor{
Vendor: sdk.VendorTypeMrSpeedy,
Credential: "",
},
VehicleType: sdk.VehicleTypeMotobike,
Type: sdk.DeliveryTypeDocument,
IsCashAccount: true,
Points: []sdk.DeliveryContact{pointOne, pointTwo},
})
```
* Get Delivery - Get delivery by id
```go
sdk.NewClient(sdk.Client{
ID: "123456789",
Secret: "123456789",
IsSandbox: true,
PrivateKey: []byte(`---private key---`),
PublicKey: []byte(`---public key---`),
}).GetDeliveryByID("1")
```
* Ekyc - MyKad Recognition
```go
sdk.NewClient(sdk.Client{
ID: "123456789",
Secret: "123456789",
IsSandbox: true,
PrivateKey: []byte(`---private key---`),
AccessToken: `access token`,
}).EkycMyKad(sdk.RequestEkycMykad{
Image: `base64 image`, // an image that contains MyKad
NotifyUrl: `https://your-backend-notify-path` // a POST request handler to receive ekyc result
})
```
* Ekyc - Face Comparison
```go
sdk.NewClient(sdk.Client{
ID: "123456789",
Secret: "123456789",
IsSandbox: true,
PrivateKey: []byte(`---private key---`),
AccessToken: `access token`,
}).EkycMyKad(sdk.RequestEkycFaceCompare{
Image1: `base64 image`, // an image that contains a face
Image2: `base64 image`, // an image that contains a face
})
```
* Ekyc - Liveness Verification
```go
sdk.NewClient(sdk.Client{
ID: "123456789",
Secret: "123456789",
IsSandbox: true,
PrivateKey: []byte(`---private key---`),
AccessToken: `access token`,
}).EkycLiveness(sdk.RequestEkycLiveness{
Image: `base64 image`, // an image that contains a face
MykadRequestID: `123456789`, // request ID from MyKad Recognition
})
```
* Ekyc - Get Mykad Result
```go
sdk.NewClient(sdk.Client{
ID: "123456789",
Secret: "123456789",
IsSandbox: true,
PrivateKey: []byte(`---private key---`),
AccessToken: `access token`,
}).GetMykadResult(sdk.RequestGetMykadResult{
ID: `123456789`, // the mykad request id
})
```
* Ekyc - Get Landmarks Info
```go
sdk.NewClient(sdk.Client{
ID: "123456789",
Secret: "123456789",
IsSandbox: true,
PrivateKey: []byte(`---private key---`),
AccessToken: `access token`,
}).GetLandmarkInfo(sdk.RequestGetLandmarkInfo{
ID: `123456789`, // the mykad request id
Includes: ["msc_logo", "malaysia_flag"], // optional parameter to specify landmark types to be acquired
})
```
* Ekyc - Get eKYC Result
```go
sdk.NewClient(sdk.Client{
ID: "123456789",
Secret: "123456789",
IsSandbox: true,
PrivateKey: []byte(`---private key---`),
AccessToken: `access token`,
}).GetEkycResult(sdk.RequestGetEkycResult{
ID: `123456789`, // the ekycId obtained after liveness verification
Includes: ["mykadImage", "selfieImage"], // optional parameter to obtain request images
})
```