POST api/v100/users/NetworkAuthRegister
Register a new Account.
Request Information
URI Parameters
None.
Headers
| Name | Description | Type | Additional information |
|---|---|---|---|
| appkey |
Ej. abcdefghijk |
None. |
Body Parameters
RqUsersNetworkAuth| Name | Description | Type | Additional information |
|---|---|---|---|
| key |
Public encryption key used to encrypt email information |
string |
Required String length: inclusive between 0 and 100 |
| data |
Encrypted email information using encryption key and later encoded using base64. Decrypted data will be a JSON as described below. |
string |
Required |
| rqSessionTK |
Data from Device to get Session Token |
RqSessionTK |
None. |
Request Formats
application/json, text/json
{
"key": "sample string 1",
"data": "sample string 2",
"rqSessionTK": {
"FKAppGroup": 1,
"password": "sample string 1",
"email": "sample string 2",
"deviceID": "sample string 3",
"devicePlatform": "sample string 4",
"deviceName": "sample string 5",
"keepAlive": true,
"apiKey": "sample string 7",
"otherInfo": "sample string 8"
}
}
application/x-www-form-urlencoded
Response Information
Resource Description
RsUsers| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Identifier |
integer |
Required |
| userGuid |
User Guid |
string |
Required |
| name |
User Name |
string |
Required |
|
|
string |
Required |
|
| displayReceiptOnSale |
Display automatically a receipt after each transaction on mobile device. |
boolean |
None. |
| emailReceiptOnSale |
Send automatically a receipt after each transaction. |
boolean |
None. |
| receiptEmail |
List of users that will receive the receipt email is EmailReceiptOnSale is true. |
string |
None. |
| lowBalanceThreshold |
If the user account balance is below this threshold, an email will be sent to the user. |
decimal number |
None. |
| fullTankAmount |
Dafault value for each transaction. |
decimal number |
None. |
| receiptPageSize |
Quantity of receipts displayed on each page. |
integer |
None. |
| language |
Language ISO Code. |
string |
String length: inclusive between 0 and 5 |
| numberSitesToLocate |
Language ISO Code. |
integer |
String length: inclusive between 0 and 5 |
| idCountry |
id Country of the Country |
integer |
Required |
| status |
User Status |
integer |
Required |
| rsSessionTK |
User Status |
RsSessionTK |
Required |
| result |
Includes Result Code Information. See Return Codes Section below.
RsResultUsed |
Result |
Required |
| debug |
Returns the FEP URL, allow null |
string |
String length: inclusive between 0 and 50 |
| networkAccounts |
List of Network Accounts associated to the user |
None. |
Response Formats
application/json, text/json
{
"id": 1,
"userGuid": "sample string 2",
"name": "sample string 3",
"email": "sample string 4",
"displayReceiptOnSale": true,
"emailReceiptOnSale": true,
"receiptEmail": "sample string 5",
"lowBalanceThreshold": 1.0,
"fullTankAmount": 1.0,
"receiptPageSize": 1,
"language": "sample string 6",
"numberSitesToLocate": 7,
"idCountry": 8,
"status": 9,
"rsSessionTK": {
"sessionTK": "sample string 1",
"userGuid": "sample string 2"
},
"result": null,
"debug": "sample string 10",
"networkAccounts": [
{
"id": 1,
"providerID": "sample string 2",
"name": "sample string 3"
},
{
"id": 1,
"providerID": "sample string 2",
"name": "sample string 3"
}
]
}