浏览代码

免费旋转文档

qingjie 1 周之前
父节点
当前提交
09777ad86d

+ 1 - 1
transfer/en/API_release_version.md

@@ -15,4 +15,4 @@
   |1.1.10| (1) [Withdraw] "/api/game/withdraw"   Adds a unique identifier for the Request parameter transaction(traceid)"  | 2025.2.14 |
   |1.1.11| (1) [Game Lobby Access] Game Lobby Access Process Description  | 2025.4.18 |
   |1.1.12| (1) [kick out Player]  Add the interface for kicking out players  | 2025.6.24 |
-    |1.1.13| (1) Add interface documentation related to free activities  | 2025.9.19 |
+  |1.1.13| (1) Add interface documentation related to free activities  | 2025.9.19 |

+ 7 - 8
transfer/en/_sidebar.md

@@ -20,6 +20,12 @@
    * [Get free game count](en/free_count)
    * [Game Lobby Access](en/lobby)
    * [Kick Out The Player](en/kickout)
+   * [Freespin Create](en/freespin_create)
+   * [Freespin Cancel](en/freespin_cancel)
+   * [Freespin Addplayer](en/freespin_addplayer)
+   * [Freespin Delplayer](en/freespin_delplayer)
+   * [Freespin Player Activity Recored](en/freespin_getplayerfrb)
+   * [Freespin Get Bet Config](en/freespin_gamebetconfi)
 * [Appendix](en/appendice)
    * [List of Transaction Columns](en/Transaction_data)
    * [Currencies List](en/currency)
@@ -29,14 +35,7 @@
    * [Game Mode](en/game_mode)
    * [Game Type](en/game_type) 
    * [Error Code](en/errorcode)
-   * [Game Lobby Access](en/lobby)
-   * [Kick Out Player](en/kickout)
-   * [Freespin Create](en/freespin_create)
-   * [Freespin Cancel](en/freespin_cancel)
-   * [Freespin Addplayer](en/freespin_addplayer)
-   * [Freespin Delplayer](en/freespin_delplayer)
-   * [Freespin Player Activity Recored](en/freespin_getplayerfrb)
-   * [Freespin Get Bet Config](en/freespin_gamebetconfi)
+
    
 
 

+ 86 - 0
transfer/en/freespin_addplayer.md

@@ -0,0 +1,86 @@
+# <font >Freespin Create</font>
+## Description
+
+> By using this method, operators can add players to the existing free round bonuses. Players can only participate in the same activity once.
+
+> Request method:( Host-> BeSoft):post 
+
+> Encoding method:application/x-www-form-urlencoded
+
+> Besoft The response data format is: application/json
+
+##  Method URL
+```
+{besoftapi}/api/bonus/addplayer
+```
+
+## Hash computation
+Hash code is calculated through the following steps:
+Obtain all parameters (expected hash) from the request POST parameters and append them to the string:
+- 1. Sort all parameters in alphabetical order.
+- 2. Append them in key1=value1&key2=value2 (if the values are not empty)
+- 3. Additional key, namely:
+```
+key1=value1&key2=value&hashkey=djds83h^&*j3u5j32
+```
+- 4. Calculate the hash using MD5 and convert it to all uppercase letters.
+- 5. Append the name "hash" to the parameter instead of the hashkey field. The final parameter is:
+```
+key1=value1&key2=value&hash=3E8ABC6949A0A0CFF9110CF1128FBE25
+```
+- 6. If the comparison between the platform and the hash parameter fails. Send error code 1008.
+
+
+##  Request Parameters
+
+ |      Name      |    Type     | Required |                    Description                     |
+ | :--------: | :---------: | :--: | :--------------------------------------------------: |
+ | extension1 |   string    |  Y   |                       Agent account                       |
+ |    cert    |   string    |  Y   |                       Security code                       |
+ | bonuscode  | String(128) |  Y   |             The unique reward identifier in the operator system              |
+ | playerlist |   string    |  Y   | The list of player ids to be added to the existing free round rewards (separated by commas) |
+ |    hash    |   string    |  Y   |                     The requested hash code                       |
+
+
+## Example
+- URL:
+    - http://127.0.0.1:8000/api/bonus/addplayer
+- HTTP Method
+    -   POST
+- Form Data
+    > Content-Type: application/x-www-form-urlencoded
+    ``` 
+    extension1:         adminweb
+    cert:               v8VMKKzlPpD0te4rX99Hgefs3PQrBFWJKiuUqg6Y
+    bonuscode:          aaabbbccc
+    playerlist:         2515,454156,55415415,6156416,75415456,81564564
+    hash:               165BB0FEEB254154DE1AEF36E7ED48C2
+    ```
+	
+	
+## Return Result
+
+ | Name | Type| Description |
+ |:--------:|:-----:|:--------:|
+ | ret | int |  status code   |
+ | info | string | Result description |
+
+
+ ##  Successful Result
+
+```
+{
+	"ret": -1,
+	"info": "ok"
+}
+```
+
+
+ ## Failed Result
+
+```
+{
+	"ret": 1008,
+	"info": "param erro"
+}
+```

+ 84 - 0
transfer/en/freespin_cancel.md

@@ -0,0 +1,84 @@
+# <font >Freespin Create</font>
+## Description
+
+> By this method, operators can cancel the free round reward activities that have been created. However, players who have already participated will continue to complete the rewards and will not be affected.
+
+> Request method:( Host-> BeSoft):post 
+
+> Encoding method:application/x-www-form-urlencoded
+
+> Besoft The response data format is: application/json
+
+##  Method URL
+```
+{besoftapi}/api/bonus/cancel
+```
+
+## Hash computation
+Hash code is calculated through the following steps:
+Obtain all parameters (expected hash) from the request POST parameters and append them to the string:
+- 1. Sort all parameters in alphabetical order.
+- 2. Append them in key1=value1&key2=value2 (if the values are not empty)
+- 3. Additional key, namely:
+```
+key1=value1&key2=value&hashkey=djds83h^&*j3u5j32
+```
+- 4. Calculate the hash using MD5 and convert it to all uppercase letters.
+- 5. Append the name "hash" to the parameter instead of the hashkey field. The final parameter is:
+```
+key1=value1&key2=value&hash=3E8ABC6949A0A0CFF9110CF1128FBE25
+```
+- 6. If the comparison between the platform and the hash parameter fails. Send error code 1008.
+
+
+##  Request Parameters
+
+ |    Name    |    Type     | Required |                     Description                     |
+ | :--------: | :---------: | :------: | :-------------------------------------------------: |
+ | extension1 |   string    |    Y     |                    Agent account                    |
+ |    cert    |   string    |    Y     |                    Security code                    |
+ | bonuscode  | String(128) |    Y     | The unique reward identifier in the operator system |
+ |    hash    |   string    |    Y     |               The requested hash code               |
+
+
+## Example
+- URL:
+    - http://127.0.0.1:8000/api/bonus/cancel
+- HTTP Method
+    -   POST
+- Form Data
+    > Content-Type: application/x-www-form-urlencoded
+    ``` 
+    extension1: adminweb
+    cert:       v8VMKKzlPpD0te4rX99Hgefs3PQrBFWJKiuUqg6Y
+    bonuscode:  aaabbbccc
+    hash:       3ECE2322AA1952D0A818DD1F09493B60
+    ```
+	
+	
+## Return Result
+
+ | Name | Type| Description |
+ | :--: | :----: | :------: |
+ | ret | int |  status code   |
+ | info | string | Result description |
+
+
+ ##  Successful Result
+
+```
+{
+	"ret": -1,
+	"info": "ok"
+}
+```
+
+
+ ## Failed Result
+
+```
+{
+	"ret": 1008,
+	"info": "param erro"
+}
+```

+ 114 - 0
transfer/en/freespin_create.md

@@ -0,0 +1,114 @@
+# <font >Freespin Create</font>
+## Description
+
+> Through this method, operators can create free round reward activities for the game. When a network error occurs, the operator can send repeated requests to create a free round. If there is a valid FR reward with the same reward code, the system will not create a new RF reward.
+
+> Request method:( Host-> BeSoft):post 
+
+> Encoding method:application/x-www-form-urlencoded
+
+> Besoft The response data format is: application/json
+
+##  Method URL
+```
+{besoftapi}/api/bonus/create
+```
+
+## Hash computation
+Hash code is calculated through the following steps:
+Obtain all parameters (expected hash) from the request POST parameters and append them to the string:
+- 1. Sort all parameters in alphabetical order.
+- 2. Append them in key1=value1&key2=value2 (if the values are not empty)
+- 3. Additional key, namely:
+```
+key1=value1&key2=value&hashkey=djds83h^&*j3u5j32
+```
+- 4. Calculate the hash using MD5 and convert it to all uppercase letters.
+- 5. Append the name "hash" to the parameter instead of the hashkey field. The final parameter is:
+```
+key1=value1&key2=value&hash=3E8ABC6949A0A0CFF9110CF1128FBE25
+```
+- 6. If the comparison between the platform and the hash parameter fails. Send error code 1008.
+
+
+##  Request Parameters
+
+ |      Name      |    Type     | Required |                    Description                     |
+ | :------------: | :---------: | :------: | :------------------------------------------------: |
+ |   extension1   |   string    |    Y     |                      Agent account                      |
+ |      cert      |   string    |    Y     |                      Security code                      |
+ |   bonuscode    | String(128) |    Y     |            The unique reward identifier in the operator system            |
+ |     rounds     |    int32    |    Y     |                     Free rounds                     |
+ |    maxscore    |    int64    |    Y     |           The upper limit of points that players can always obtain in this event           |
+ |   startdata    |    int64    |    Y     |           The start timestamp of participation in the reward activity (in milliseconds)           |
+ |    enddata     |    int64    |    Y     |           The end timestamp of participation in the reward activity (in milliseconds)          |
+ |  validitydata  |    int64    |    Y     |            The deadline timestamp (in milliseconds) after the player takes effect            |
+ |     games      |   string    |    Y     | json array string, configure the games that can be participated in, and the game betting information |
+ |   games.gid    |   string    |    Y     |                      Game gid                       |
+ | games.betindex |    int32    |    Y     |                    Game betting index                    |
+ |  games.betmu   |    int32    |    Y     |                    Game betting multiple                    |
+ |      hash      |   string    |    Y     |                   The requested hash code                   |
+
+
+
+
+**The game betting configuration can be obtained through the interface:** [Get Bet Config](en/freespin_gamebetconfi)
+
+## Example
+- URL:
+    - http://127.0.0.1:8000/api/bonus/create
+- HTTP Method
+    -   POST
+- Form Data
+    > Content-Type: application/x-www-form-urlencoded
+    ``` 
+    extension1:     adminweb
+    cert:           v8VMKKzlPpD0te4rX99Hgefs3PQrBFWJKiuUqg6Y
+    bonuscode:      aaabbbccc
+    rounds:         11
+    maxscore:       1000
+    startdata:      1752042214512
+    enddata:        1752052214512
+    validitydata:   1752152214512
+    games:          [
+                        {
+                            "gid": "be001",
+                            "betindex": 0,
+                            "betmul": 1
+                        },
+                        {
+                            "gid": "be022",
+                            "betmul": 1,
+                            "betindex": 0
+                        }
+                    ]
+    hash:           3E8ABC6949A0A0CFF9110CF1128FBE25
+    ```
+	
+	
+## Return Result
+
+ | Name | Type| Description |
+ |:--------:|:-----:|:--------:|
+ | ret | int |  status code   |
+ | info | string | Result description |
+
+
+ ##  Successful Result
+
+```
+{
+	"ret": -1,
+	"info": "ok"
+}
+```
+
+
+ ## Failed Result
+
+```
+{
+	"ret": 1008,
+	"info": "param erro"
+}
+```

+ 87 - 0
transfer/en/freespin_delplayer.md

@@ -0,0 +1,87 @@
+# <font >Freespin Create</font>
+## Description
+
+
+> By using this method, operators can remove players from their existing free round bonuses. However, players who have already participated will continue to complete the rewards and will not be affected.
+
+> Request method:( Host-> BeSoft):post 
+
+> Encoding method:application/x-www-form-urlencoded
+
+> Besoft The response data format is: application/json
+
+##  Method URL
+```
+{besoftapi}/api/bonus/delplayer
+```
+
+## Hash computation
+Hash code is calculated through the following steps:
+Obtain all parameters (expected hash) from the request POST parameters and append them to the string:
+- 1. Sort all parameters in alphabetical order.
+- 2. Append them in key1=value1&key2=value2 (if the values are not empty)
+- 3. Additional key, namely:
+```
+key1=value1&key2=value&hashkey=djds83h^&*j3u5j32
+```
+- 4. Calculate the hash using MD5 and convert it to all uppercase letters.
+- 5. Append the name "hash" to the parameter instead of the hashkey field. The final parameter is:
+```
+key1=value1&key2=value&hash=3E8ABC6949A0A0CFF9110CF1128FBE25
+```
+- 6. If the comparison between the platform and the hash parameter fails. Send error code 1008.
+
+
+##  Request Parameters
+
+ |      Name      |    Type     | Required |                    Description                     |
+ | :--------: | :---------: | :--: | :--------------------------------------------------: |
+ | extension1 |   string    |  Y   |                        Agent account                        |
+ |    cert    |   string    |  Y   |                        Security code                         |
+ | bonuscode  | String(128) |  Y   |              The unique reward identifier in the operator system            |
+ | playerlist |   string    |  Y   | The list of player ids to be deleted for free round rewards (separated by commas) |
+ |    hash    |   string    |  Y   |                    The requested hash code                     |
+
+
+## Example
+- URL:
+    - http://127.0.0.1:8000/api/bonus/delplayer
+- HTTP Method
+    -   POST
+- Form Data
+    > Content-Type: application/x-www-form-urlencoded
+    ``` 
+    extension1:         adminweb
+    cert:               v8VMKKzlPpD0te4rX99Hgefs3PQrBFWJKiuUqg6Y
+    bonuscode:          aaabbbccc
+    playerlist:         75415456,81564564
+    hash:               165BB0FEEB254154DE1AEF36E7ED48C2
+    ```
+	
+	
+## Return Result
+
+ | Name | Type| Description |
+ |:--------:|:-----:|:--------:|
+ | ret | int |  status code   |
+ | info | string | Result description |
+
+
+ ##  Successful Result
+
+```
+{
+	"ret": -1,
+	"info": "ok"
+}
+```
+
+
+ ## Failed Result
+
+```
+{
+	"ret": 1008,
+	"info": "param erro"
+}
+```

+ 127 - 0
transfer/en/freespin_gamebetconfi.md

@@ -0,0 +1,127 @@
+# <font >Freespin Create</font>
+## Description
+
+> By using this method, the entertainment venue operator system can obtain the betting configurations of all games from the system to create free giveaway events.
+
+> Request method:( Host-> BeSoft):post 
+
+> Encoding method:application/x-www-form-urlencoded
+
+> Besoft The response data format is: application/json
+
+##  Method URL
+```
+{besoftapi}/api/bonus/gamebetconfig
+```
+
+
+
+##  Request Parameters
+
+  |    Name    |  Type  | Required |  Description  |
+  | :--------: | :----: | :------: | :-----------: |
+  | extension1 | string |    Y     | Agent account |
+  |    cert    | string |    Y     | Security code |
+
+
+
+## Example
+- URL:
+    - http://127.0.0.1:8000/api/bonus/getplayerfrb
+- HTTP Method
+    -   POST
+- Form Data
+    > Content-Type: application/x-www-form-urlencoded
+    ``` 
+    extension1:         adminweb
+    cert:               v8VMKKzlPpD0te4rX99Hgefs3PQrBFWJKiuUqg6Y
+    ```
+	
+	
+## Return Result
+
+ | Name | Type| Description |
+ | :------------------: | :----: | :--------------: |
+ |        games         | object |   Game configuration list   |
+ |      games.key       | string |     Game gid      |
+ |  games.value.areaid  |  int   |      Regional id      |
+ | games.value.currency | string |     Monetary symbol     |
+ | games.value.betextra |  int   |     Additional bets     |
+ |   games.value.bet    | array  | You can place bets on the score list |
+ |  games.value.betmul  | array  | A list of bet multiples is available |
+ | games.value.betline  | array  |  The number of selectable betting lines  |
+
+ ##  Successful Result
+
+```
+{
+	"games": {
+		"afa001": {
+			"areaid": 1,
+			"currency": "USD",
+			"betextra": 0,
+			"bet": [
+				100,
+				500,
+				1000,
+				3000,
+				5000
+			],
+			"betline": [
+				20
+			],
+			"betmul": [
+				1,
+				2,
+				3,
+				4,
+				5,
+				6,
+				7,
+				8,
+				9,
+				10
+			]
+		},
+		"afa002": {
+			"areaid": 1,
+			"currency": "USD",
+			"betextra": 0,
+			"bet": [
+				100,
+				300,
+				1000,
+				3000,
+				5000
+			],
+			"betline": [
+				20
+			],
+			"betmul": [
+				1,
+				2,
+				3,
+				4,
+				5,
+				6,
+				7,
+				8,
+				9,
+				10
+			]
+		}
+	},
+	"code": 0,
+	"msg": "success"
+}
+```
+
+
+ ## Failed Result
+
+```
+{
+	"ret": 1008,
+	"info": "param erro"
+}
+```

+ 98 - 0
transfer/en/freespin_getplayerfrb.md

@@ -0,0 +1,98 @@
+# <font >Freespin Create</font>
+## Description
+
+> By using this method, the entertainment venue operator system can obtain all the activities that players can participate in from the system.
+
+> Request method:( Host-> BeSoft):post 
+
+> Encoding method:application/x-www-form-urlencoded
+
+> Besoft The response data format is: application/json
+
+##  Method URL
+```
+{besoftapi}/api/bonus/getplayerfrb
+```
+
+## Hash computation
+Hash code is calculated through the following steps:
+Obtain all parameters (expected hash) from the request POST parameters and append them to the string:
+- 1. Sort all parameters in alphabetical order.
+- 2. Append them in key1=value1&key2=value2 (if the values are not empty)
+- 3. Additional key, namely:
+```
+key1=value1&key2=value&hashkey=djds83h^&*j3u5j32
+```
+- 4. Calculate the hash using MD5 and convert it to all uppercase letters.
+- 5. Append the name "hash" to the parameter instead of the hashkey field. The final parameter is:
+```
+key1=value1&key2=value&hash=3E8ABC6949A0A0CFF9110CF1128FBE25
+```
+- 6. If the comparison between the platform and the hash parameter fails. Send error code 1008.
+
+##  Request Parameters
+
+ |      Name      |    Type     | Required |                    Description                     |
+ | :--------: | :---------: | :--: | :--------------------------: |
+ | extension1 |   string    |  Y   |           Agent account             |
+ |    cert    |   string    |  Y   |           Security code            |
+ | bonuscode  | String(128) |  Y   |  The unique reward identifier in the operator system  |
+ |   userid   |    int64    |  Y   |            user id            |
+ |    hash    |   string    |  Y   |        The requested hash code        |
+
+
+## Example
+- URL:
+    - http://127.0.0.1:8000/api/bonus/getplayerfrb
+- HTTP Method
+    -   POST
+- Form Data
+    > Content-Type: application/x-www-form-urlencoded
+    ``` 
+    extension1:         adminweb
+    cert:               v8VMKKzlPpD0te4rX99Hgefs3PQrBFWJKiuUqg6Y
+    bonuscode:          aaabbbccc
+    userid:             81564564
+    hash:               165BB0FEEB254154DE1AEF36E7ED48C2
+    ```
+	
+	
+## Return Result
+
+ | Name | Type| Description |
+ | :---------------: | :----: | :----------------: |
+ |      bonuses      | array  |      Activity list      |
+ | bonuses.currency  | string |     Currency symbol     |
+ | bonuses.bonuscode | string |     Unique ID for the event     |
+ |  bonuses.gidlist  | string | A list of games that can be participated in |
+ |   bonuses.round   |  int   | Free spins given as a gift |
+ |  bonuses.enddata  | int64  |    End date of the event    |
+
+
+ ##  Successful Result
+
+```
+{
+	"bonuses": [
+		{
+			"currency": "USD",
+			"bonuscode": "aaabbbccc",
+			"gidlist": "be001,be022,be002,afa013,afa014,afa019",
+			"round": 11,
+			"enddata": 1752052214512
+		}
+	],
+	"code": 0,
+	"msg": "success"
+}
+```
+
+
+ ## Failed Result
+
+```
+{
+	"ret": 1008,
+	"info": "param erro"
+}
+```