APIs

User infomation

1. API name

Test environment: https://up-oauth.pengpengla.com/getUserInfo

Product environment: https://gameopenapi.schirst.com/getUserInfo

2. Parameter description

  • Request method: GET

  • Upload parameter

Parameter Necessary Description
access_token YES Voucher for invoking open APIs
open_id YES The unique of Funpepper user in application developed by developer.
  • Response
Parameter Description
open_id The unique of Funpepper user in application developed by developer
username user name
gender The user’s gender
avatar The user’s avatar
country_code The user’s country, such as CN, IN and US.
uplive_code unique id of user on Funpepper
language language code, such as zh-CN. the field is no value, so can be ignored.

3. Request example 

https://up-oauth.pengpengla.com/getUserInfo?access_token=ACCESS_TOKEN&open_id=OPENID

Response：

  • request successfully：
{
avatar: "http://p.cdn.upliveapps.com/uplive/p/u/2018/9/11/5038085.jpg",
country_code: "CN",
gender: 1,
language: "",
open_id: "101015150d5e4e40445b755f5445",
uplive_code: "zt2a92l6",
username: "USERNAME"
}
  • request failed：
{
  "errno":"000002",
  "errmsg":"params error"
}
{
  "errno":"000006",
  "errmsg":"access_token invalid"
}

Check the number of diamond/gold in user account

Note: diamond is currency in game.

1. API name
diamond:

gold:

2. Parameter description

  • Request method：GET

  • Upload parameter

Parameter Necessary Description
access_token YES Voucher for invoking open APIs
open_id YES The unique of Funpepper user in application developed by developer.
  • Response
Parameter Description
diamond/gold the diamond/gold amount of user’s account

3. Request example 

https://up-oauth.pengpengla.com/getDiamond?access_token=ACCESS_TOKEN&open_id=OPENID

Response:

  • Request successfully:
{
  "diamond" : 300 
}
  • Request failed:
{
  "errno":"000002",
  "errmsg":"params error"
}
{
  "errno":"000006",
  "errmsg":"access_token invalid"
}

Plus or minus diamond/gold to user account

1. API name
diamond:

gold:

2. Parameter description

  • Request method: POST
  • Upload parameter:
Parameter Necessary Description
access_token YES Voucher for invoking open APIs
open_id YES The unique of Funpepper user in application developed by developer.
order_id YES The unique order id created by invoker
amount YES The amount of diamond
op_type YES this field determine whether to plus or minus diamond to user. Detial: 1 plus, 2 minus
game_id YES game id
sign YES Transaction signature (letters in lowercase, signature method is shown in the following example)
  • Signature method

The purpose of signing transactions with client_secret is to enhance the security of the interface and prevent forgery transactions caused by access_token leakage.

The method of signature is to convert all parameters and their values in the request into URL format after sorting by parameter names, and then encrypt them with md5.

PHP demo：

$data["access_token"]="REPQYHEHP0GNP1WCLOS4BQ";
$data["open_id"]="4f4f57524d0607011e1931164c47494345785c4c";
$data["order_id"] = "5bee7c70ef716";
$data["amount"]=20;
$data["op_type"]=1;
$data["game_id"]=1;
$data["client_secret"] ="qv5pz3289lgpcqlwho3accb";
//sort param keys
ksort($data);
//form key/value to url format
$url_param = http_build_query($data); 
//result: $url_param = access_token=REPQYHEHP0GNP1WCLOS4BQ&amount=20&client_secret=qv5pz3289lgpcqlwho3accb&game_id=1&op_type=1&open_id=4f4f57524d0607011e1931164c47494345785c4c&order_id=5bee7c70ef716
return md5($url_param);
  • Response
Parameter Description
diamond the amount of diamond

3. Request example

Response:

  • Request successfully:
{
​  "diamond" : 300
}
  • Request failed:
{
  "errno":"000002",
  "errmsg":"params error"
}
{
  "errno":"000003",
  "errmsg":"order no exist"
}
{
  "errno":"000004",
  "errmsg":"insufficient money"
}
{
  "errno":"000005",
  "errmsg":"user frozen"
}
{
  "errno":"000006",
  "errmsg":"access_token invalid"
}

Check diamond/gold transaction order status

1. API name
diamond：

gold：

2. Parameter description

  • Resquest method: GET
  • Upload parameter
Parameter Necessary Description
access_token YES Voucher for invoking open APIs
open_id YES the unique of Funpepper user in application developed by developer.
order_id YES existent transaction order id
op_type YES 1:puls 2:minus
  • Response
Parameter Description
success fixed boolean, true: transaction is successful

3. Request example

Response:

  • Request successfully:
{
  "success" : true
}
  • Request failed:
{
"errno":"000002",
"errmsg":"params error"
}
{
"errno":"000008",
"errmsg":"order not exist"
}

Appendix

error code

Code Description
000001 Server internal error
000002 Parameter error
000003 Order number is repeated
000004 The balance of diamond is not enough
000005 account are frozen and cannot be plused or minused diamond
000006 access_token is invalid or expired
000007 code is invalid
000008 Order number is not existent
000009 game api closed
000010 diamond amount too large

error data format

{
  "errno": [error code], 
  "errmsg": [error message]
}