Project Detail

Description

Need to build an api to connect to my mssql database.
with the following format

2 Analysis & Design

2.1 API Summary

The Remote API is a simple set of secured remote calls to the application layer. A sample format for one of these calls is as follows:

https://<SERVER_IP>:8080/<WEBAPP>/< ACTION>.do?key=<KEY>&user=<UNAME>&pass=<PWD>

The key is a MD5 encoded passkey that is unique to each third party client. A call to this URL from an allowed third party machine will result in success/reject response.

This same type of format is used for the three types of third party integration that are allowed on the BigBoss system.

The BigBoss Remote API currently supports the following functionality:

Player Account Registration – Used to remotely register

Deposit Player Funds

Withdrawal Player Funds

Change Player Account Password

Check Player Current Balance

2.2 API Detail

Account registration:

Sample use case: A client has an existing website where the players will get access

http://<SERVER_IP>:8080/<WEBAPP>/ playerRegRemote.do?key=<KEY>&user=<USER>&pass=<PWD>

Required Parameters

KEY = Customized Key specific to each client

UNAME = Username of new account

PWD = Password (MD5 encrypted) of new account

Change Account Status:

http://<SERVER_IP>:8080/<WEB-APP>/ changeStatusRemote.do?key=<KEY>&user=<UNAME>&status=<STATUS_CODE>

Required Parameters

KEY = Customized Key specific to each client UNAME = Username of new account

STATUS_CODE = new player status (INACTIVE, ACTIVE, TERMINATED, EXPIRED, SUSPENDED) **note that this is case sensitive

Project Name Version 1.3

Module Name – Detailed Design Page 6 of 9





Account crediting of player balance:

http://<SERVER_IP>:8080/<WEBAPP>/ playerWithdrawRemote.do?key=<KEY>&amount=<AMT>&user=<USER>

Required Parameters

KEY = Customized Key specific to each client

USER = Username of new account

AMT = Amount to credit the player’s balance

Account debiting of player balance:

http://<SERVER_IP>:8080/<WEB-APP>/playerDepositRemote.do?key=<KEY>& amount=<AMT>&user=< USER >

Required Parameters

KEY = Customized Key specific to each client

USER = Username of new account

PWD = Password (in clear text) of new account

AMT = Amount to debit the player’s balance

Changing of account password:

http://<SERVER_IP>:8080/<WEB-APP>/playerChangePassRemote.do?key=<KEY>&user= <USER>&oldpass=<OLDPWD>&newpass=<NEWPWD>

Required Parameters

KEY = Customized Key specific to each client USER = Username of account

OLDPWD = Password (MD5 encrypted) of existing password NEWPWD = New password for the account (MD5 encrypted)

Cash balance request: http://<SERVER_IP>:8080/<WEB-APP>/playerListCashBalanceRemote.do?key=<KEY>

Required Parameters

KEY = Customized Key specific to each client Optional Parameters

FIELD = (id/username) field to search

VAL = value of the criteria to be searched in comma separated format.

Sample Response

<list>

<PlayerCashBalance>

<id>5</id>

<username>123</username>

<cashBalance>4.50</cashBalance>

</PlayerCashBalance>

<PlayerCashBalance>

<id>8</id>

<username>hwamin</username>

<cashBalance>0.0</cashBalance>

</PlayerCashBalance>

</list>





Game Reporting:

http://<SERVER_IP>:8080/<WEB-APP>/remoteReport.do?key=<KEY>&user=<USER>&st art=<START>&end=<END>&game=<GAME_TYPE>

Required Parameters

KEY = Customized Key specific to each client

USER = Username of the player

GAME_TYPE = game type (0 - all, 1 - baccarat, 2 - roulette, 3 – sicbo, 4 –

SuperSix, 5 – DragonTiger)

Optional Parameters

START = Starting date of query (yyyy/MM/dd HH:mm:ss)

END = Ending date of query (yyyy/MM/dd HH:mm:ss)

Response

Response is in JSON format.

Sample Response <response>
<result>SUCCESS</result> <list game="baccarat" size="1">
<item row="1"> <hand-id>4693293</hand-id>

<play-date>01/06/2009 10:58:41</play-date> <username>deyb2</username> <banker-bet>0.0</banker-bet> <banker-pair-bet>0.0</banker-pair-bet> <player-bet>0.0</player-bet> <player-pair-bet>0.0</player-pair-bet> <tie-bet>100.0</tie-bet>

<banker-hand>HK HJ </banker-hand> <player-hand>SQ C8 </player-hand> <bet-amount>100.0</bet-amount> <result>P</result> <loss>100.0</loss> <win>0.0</win> <income>100.0</income> <payout>0.0</payout> <refund>0.0</refund>

</item>

</list>

<list game="sicbo" size="0"/> <list game="supersix" size="0"/>

<list game="dragontiger" size="0"/> </response>

2.3 Security

The third party client must connect using a predetermined key obtained from BigBoss order for these calls to be successful. In addition, the originating IP of the machine making these calls must be provided and added to a white list within the system or else the call will fail.





2.4 Response Handling and Error Codes

Each remote call will result in a result code response to the caller in xml format with a <result> element that is determined by the result of the remote call. A sample XML response from the remote API for a successful call looks like:

<xml>

<result>SUCCESS</result>

</xml>

In the case of some form of error the result element will be “ERROR” and there will be another element called <error_code> which provide the remote system additional information as to the reason behind the error.

The system supports the following error codes:

CODE MEANING

-6 Player Is Not Logged In

-5 General Error, Please Contact “Suplier” Support -4 Invalid HTTP Method

-3 Invalid GeoIP Location

-2 Invalid Request Source -1 invalid key

0 No Results Found

1 Invalid Parameters

2 Player Has Pending Bet

3 Withdraw Request Exceeds Current Balance

4 Existing Username

5 Empty Password

6 Existing Password Doesn't Match

7 Username Doesn't Exist

8 Invalid Amount Format

11 User Is Already Logged In

12 Invalid Status Code

A sample error response would look like:

<xml> <result>ERROR</result>

<error_code>-1</error_code>

</xml>


Additional files submitted:
bigboss-remote-API-v1.3.pdf
bigboss-remote-API-v1.3[1].rtf