Access Method
All interface need to use POST way to access.
Interface Authorization
In order to ensure the security of user interface calls, all private interfaces require authorization. There is need to provide interface access authorization parameters when accessing.
Parameter | Type | Description |
---|---|---|
opId | String | Operator ID, each operator has a unique ID when registering |
String | User email, to query sub-account list and other information | |
userId | String | User ID,to query sub-account information |
workerId | String | Worker ID, to query worker information |
coin | String | Coin type: BTC、BCC(Bitcoin Cash)、ETH、ETC、LTC、ZEC、SC and so on |
paymentType | String | Payment record acquisition type,default is payment records.Payout:payment record; pps: PPS revenue record |
page | Integer | Page number, default is the first page |
pageSize | Integer | Page size for records, default is 10 records per page, maximum limit is 50 |
key | String | System generates the API key, each API key can control the interface access, IP access control, and encrypt record value |
secret | String | System generates the API secret, which is used to generate signature |
record | String | Request data will be assembled through Json |
params | String | encrypt record data with AES using API key |
nonce | Long | Nonce is a number, it should be increased each time when calling interface, such as one time calling, nonce is 1 , the next call needs to be bigger than 1.A UTC time stamp is always used as a usual practice |
sign | String | Signature use the HMAC-SHA256 method:coin+ opID+ record(Parameter Json string before AES). When signature, must use the HMAC-SHA256 code generated by API secret key. The data after signature need to be converted to hexadecimal capitalized characters. |