Financial_Authenticate
Thu Feb 17 2022 13:14:10 GMT+0000 (Coordinated Universal Time)
Saved by @nirmalkumar
<?xml version="1.0" encoding="utf-8"?>
<html xmlns:MadCap="http://www.madcapsoftware.com/Schemas/MadCap.xsd">
<head>
<link href="../Resources/TableStyles/NewStyle.css" rel="stylesheet" MadCap:stylesheetType="table" />
</head>
<body>
<MadCap:breadcrumbsProxy MadCap:conditions="Default.Web" style="padding-bottom: 10px;border-bottom-style: solid;border-bottom-width: 1px;font-family: 'Segoe UI';border-bottom-color: #acacac;font-weight: bold;" />
<h1 class="main-container-header">Authenticate</h1>
<table style="width: 100%;">
<col style="width: 859px;" />
<col style="width: 1141px;" />
<tbody>
<tr>
<td style="width: 100%;">
<!-- main - container start -->
<div class="main-container">
<!-- main left content start -->
<div class="main-content">
<h6>http://{evi-server-url}/Authenticate</h6>
<p> </p>
<p>Once a player opens a game, an Authentication request will be sent to EVI in order to validate the player.</p>
<p> </p>
<h2>POST Request</h2>
<table style="width: 100%;mc-table-style: url('../Resources/TableStyles/NewStyle.css');margin-left: 0;margin-right: auto;" class="TableStyle-NewStyle" cellspacing="3">
<col class="TableStyle-NewStyle-Column-Column1">
</col>
<col class="TableStyle-NewStyle-Column-Column2">
</col>
<col class="TableStyle-NewStyle-Column-Column3">
</col>
<thead>
<tr class="TableStyle-NewStyle-Head-Header1">
<th class="TableStyle-NewStyle-HeadE-Column1-Header1">
<p>Parameter</p>
</th>
<th class="TableStyle-NewStyle-HeadE-Column2-Header1">
<p>Type</p>
</th>
<th class="TableStyle-NewStyle-HeadD-Column3-Header1">
<p>Remarks</p>
</th>
</tr>
</thead>
<tbody>
<tr class="TableStyle-NewStyle-Body-Body2">
<td class="TableStyle-NewStyle-BodyE-Column1-Body2" style="font-family: 'Segoe UI';">Account</td>
<td class="TableStyle-NewStyle-BodyE-Column2-Body2" style="font-family: 'Segoe UI';">Account</td>
<td class="TableStyle-NewStyle-BodyD-Column3-Body2" style="font-family: 'Segoe UI';">
<p>API username and password.</p>
</td>
</tr>
<tr class="TableStyle-NewStyle-Body-Body1">
<td class="TableStyle-NewStyle-BodyE-Column1-Body1" style="font-family: 'Segoe UI';">ClientToken</td>
<td class="TableStyle-NewStyle-BodyE-Column2-Body1" style="font-family: 'Segoe UI';">String</td>
<td class="TableStyle-NewStyle-BodyD-Column3-Body1" style="font-family: 'Segoe UI';">The Token that was passed in the launch game url.</td>
</tr>
<tr class="TableStyle-NewStyle-Body-Body2">
<td class="TableStyle-NewStyle-BodyE-Column1-Body2" style="font-family: 'Segoe UI';">ExtraData</td>
<td class="TableStyle-NewStyle-BodyE-Column2-Body2" style="font-family: 'Segoe UI';">String</td>
<td class="TableStyle-NewStyle-BodyD-Column3-Body2">extraData parameter that was passed on the Launch game request.</td>
</tr>
<tr class="TableStyle-NewStyle-Body-Body1">
<td class="TableStyle-NewStyle-BodyE-Column1-Body1" style="font-family: 'Segoe UI';">GameCode</td>
<td class="TableStyle-NewStyle-BodyE-Column2-Body1" style="font-family: 'Segoe UI';">String</td>
<td class="TableStyle-NewStyle-BodyD-Column3-Body1">
<p>Unique Game Code</p>
</td>
</tr>
<tr class="TableStyle-NewStyle-Body-Body2">
<td class="TableStyle-NewStyle-BodyB-Column1-Body2" style="font-family: 'Segoe UI';">ClientIP</td>
<td class="TableStyle-NewStyle-BodyB-Column2-Body2" style="font-family: 'Segoe UI';">String</td>
<td class="TableStyle-NewStyle-BodyA-Column3-Body2" style="font-family: 'Segoe UI';">The client IP of the player.</td>
</tr>
</tbody>
</table>
<p> </p>
<h2>Response</h2>
<table style="width: 100%;mc-table-style: url('../Resources/TableStyles/NewStyle.css');margin-left: 0;margin-right: auto;" class="TableStyle-NewStyle" cellspacing="3">
<col class="TableStyle-NewStyle-Column-Column1">
</col>
<col class="TableStyle-NewStyle-Column-Column2">
</col>
<col class="TableStyle-NewStyle-Column-Column3">
</col>
<thead>
<tr class="TableStyle-NewStyle-Head-Header1">
<th class="TableStyle-NewStyle-HeadE-Column1-Header1">
<p>Parameter</p>
</th>
<th class="TableStyle-NewStyle-HeadE-Column2-Header1">
<p>Type</p>
</th>
<th class="TableStyle-NewStyle-HeadD-Column3-Header1">
<p>Remarks</p>
</th>
</tr>
</thead>
<tbody>
<tr class="TableStyle-NewStyle-Body-Body2">
<td class="TableStyle-NewStyle-BodyE-Column1-Body2" style="font-family: 'Segoe UI';">PlayerId</td>
<td class="TableStyle-NewStyle-BodyE-Column2-Body2" style="font-family: 'Segoe UI';">String</td>
<td class="TableStyle-NewStyle-BodyD-Column3-Body2" style="font-family: 'Segoe UI';">
<p>The external bonus id on the vendor side.</p>
</td>
</tr>
<tr class="TableStyle-NewStyle-Body-Body1">
<td class="TableStyle-NewStyle-BodyE-Column1-Body1" style="font-family: 'Segoe UI';">CurrencyCode</td>
<td class="TableStyle-NewStyle-BodyE-Column2-Body1" style="font-family: 'Segoe UI';">String</td>
<td class="TableStyle-NewStyle-BodyD-Column3-Body1" style="font-family: 'Segoe UI';">Currency of the player. You must use the relevant ISO (4217) currency code, such as GBP for United Kingdom Pound.</td>
</tr>
<tr class="TableStyle-NewStyle-Body-Body2">
<td class="TableStyle-NewStyle-BodyE-Column1-Body2" style="font-family: 'Segoe UI';">CountryCode</td>
<td class="TableStyle-NewStyle-BodyE-Column2-Body2" style="font-family: 'Segoe UI';">String</td>
<td class="TableStyle-NewStyle-BodyD-Column3-Body2" style="font-family: 'Segoe UI';">The country of the player. You must use the relevant ISO (3166-1) code, such as AU for Australia.</td>
</tr>
<tr class="TableStyle-NewStyle-Body-Body1">
<td class="TableStyle-NewStyle-BodyE-Column1-Body1" style="font-family: 'Segoe UI';">Token</td>
<td class="TableStyle-NewStyle-BodyE-Column2-Body1" style="font-family: 'Segoe UI';">String</td>
<td class="TableStyle-NewStyle-BodyD-Column3-Body1" style="font-family: 'Segoe UI';">New generated token. This token will be used on all the requests of the current session.</td>
</tr>
<tr class="TableStyle-NewStyle-Body-Body2">
<td class="TableStyle-NewStyle-BodyE-Column1-Body2" style="font-family: 'Segoe UI';">Balance</td>
<td class="TableStyle-NewStyle-BodyE-Column2-Body2" style="font-family: 'Segoe UI';">Decimal</td>
<td class="TableStyle-NewStyle-BodyD-Column3-Body2" style="font-family: 'Segoe UI';">Player's balance</td>
</tr>
<tr class="TableStyle-NewStyle-Body-Body1">
<td class="TableStyle-NewStyle-BodyE-Column1-Body1" style="font-family: 'Segoe UI';">OperatorCode</td>
<td class="TableStyle-NewStyle-BodyE-Column2-Body1" style="font-family: 'Segoe UI';">String</td>
<td class="TableStyle-NewStyle-BodyD-Column3-Body1" style="font-family: 'Segoe UI';">The operator identifier on the EVI side.</td>
</tr>
<tr class="TableStyle-NewStyle-Body-Body2">
<td class="TableStyle-NewStyle-BodyE-Column1-Body2" style="font-family: 'Segoe UI';">ErrorCode</td>
<td class="TableStyle-NewStyle-BodyE-Column2-Body2" style="font-family: 'Segoe UI';">Integer</td>
<td class="TableStyle-NewStyle-BodyD-Column3-Body2" style="font-family: 'Segoe UI';">Error code in case the request had an error.</td>
</tr>
<tr class="TableStyle-NewStyle-Body-Body1">
<td class="TableStyle-NewStyle-BodyB-Column1-Body1" style="font-family: 'Segoe UI';">SessionData</td>
<td class="TableStyle-NewStyle-BodyB-Column2-Body1" style="font-family: 'Segoe UI';">SessionData</td>
<td class="TableStyle-NewStyle-BodyA-Column3-Body1" style="font-family: 'Segoe UI';">Holds the player session data – session balance, sum of total wins and sum of total bets. Required for the Spanish Regulation</td>
</tr>
</tbody>
</table>
<p> </p>
<h2>Possible Error Codes</h2>
<table style="width: 100%;mc-table-style: url('../Resources/TableStyles/NewStyle.css');margin-left: 0;margin-right: auto;" class="TableStyle-NewStyle" cellspacing="3">
<col class="TableStyle-NewStyle-Column-Column1" style="width: 210px;">
</col>
<col class="TableStyle-NewStyle-Column-Column2" style="width: 106px;">
</col>
<col class="TableStyle-NewStyle-Column-Column3" style="width: 325px;">
</col>
<col class="TableStyle-NewStyle-Column-Column4">
</col>
<thead>
<tr class="TableStyle-NewStyle-Head-Header1">
<th class="TableStyle-NewStyle-HeadE-Column1-Header1">
<p>Parameter</p>
</th>
<th class="TableStyle-NewStyle-HeadE-Column2-Header1">
<p>Code</p>
</th>
<th class="TableStyle-NewStyle-HeadE-Column3-Header1">
<p>Remarks</p>
</th>
<th class="TableStyle-NewStyle-HeadD-Column4-Header1">Expected Behavior</th>
</tr>
</thead>
<tbody>
<tr class="TableStyle-NewStyle-Body-Body2">
<td class="TableStyle-NewStyle-BodyE-Column1-Body2" style="font-family: 'Segoe UI';">AuthenticateFailed</td>
<td class="TableStyle-NewStyle-BodyE-Column2-Body2" style="font-family: 'Segoe UI';">1</td>
<td class="TableStyle-NewStyle-BodyE-Column3-Body2" style="font-family: 'Segoe UI';">
<p>The credentials provided in the API are wrong.</p>
</td>
<td class="TableStyle-NewStyle-BodyD-Column4-Body2">Game should crash</td>
</tr>
<tr class="TableStyle-NewStyle-Body-Body1">
<td class="TableStyle-NewStyle-BodyE-Column1-Body1" style="font-family: 'Segoe UI';">InvalidRound</td>
<td class="TableStyle-NewStyle-BodyE-Column2-Body1" style="font-family: 'Segoe UI';">4</td>
<td class="TableStyle-NewStyle-BodyE-Column3-Body1" style="font-family: 'Segoe UI';">
<p>Player Id was not found.</p>
</td>
<td class="TableStyle-NewStyle-BodyD-Column4-Body1">Game should crash</td>
</tr>
<tr class="TableStyle-NewStyle-Body-Body2">
<td class="TableStyle-NewStyle-BodyB-Column1-Body2" style="font-family: 'Segoe UI';">GeneralError</td>
<td class="TableStyle-NewStyle-BodyB-Column2-Body2" style="font-family: 'Segoe UI';">900</td>
<td class="TableStyle-NewStyle-BodyB-Column3-Body2">
<p>General error.</p>
</td>
<td class="TableStyle-NewStyle-BodyA-Column4-Body2">Game should crash</td>
</tr>
</tbody>
</table>
<p> </p>
<p> </p>
<p><b>Examples</b>:</p>
<p><b>Authenticate request</b> </p>
<p>{</p>
<p>"ClientToken": "PPT_D8A1CA355FB54904BD061AF331B52C9D",</p>
<p>"ExtraData": "op%3DWTG%26net%3DJDT", "Account": {</p>
<p>"Username": "eviuser", "Password": "evipassword"</p>
<p>},</p>
<p>"GameCode": "EVIGame_Desktop", "ClientIp": "31.154.25.321"</p>
<p>}</p>
<p> </p>
<p><b>Authenticate OK Response </b>
</p>
<p>{</p>
<p>"PlayerId": "PPT_327",</p>
<p>"Token": "DB87E8897E1B4089921032B37EA2ECF4", "Balance": 197545.35,</p>
<p>"CurrencyCode": "GBP", "CountryCode": "GB", "OperatorCode": "PPT", "SessionData": {</p>
<p>"TotalBet":20.0,</p>
<p>"TotalWin":10.0, "SessionBalance":220.0</p>
<p>}</p>
<p>}</p>
<p> </p>
<p><b>Authenticate error response </b>
</p>
<p>{</p>
<p>"Balance": 0,</p>
<p>"ErrorCode": 2</p>
<p>}</p>
</div>
<!-- main left content end -->
<div class="main-content-toc"><b>Table of Contents</b>
<MadCap:menuProxy mc-linked-toc="$topicHeadings" style="mc-toc-depth: 2;mc-context-sensitive: True;mc-include-parent: True;mc-include-siblings: True;mc-include-children: True;">
</MadCap:menuProxy>
<p> </p>
</div>
<!-- main right toc end -->
</div>
<!-- main - container end -->
</td>
</tr>
</tbody>
</table>
</body>
</html>
Comments