POST api/Customer/Login?Signature={Signature}&Language={Language}
Login the customer.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
Signature |
SHA256(Body + Client_Key) |
string |
Required |
Language | API.LANGUAGE |
Default value is en_US |
Body Parameters
Requests.Customers.LoginName | Description | Type | Additional information |
---|---|---|---|
ClientCode | string |
None. |
|
DateTime | date |
None. |
|
Content | Forms.Customers.Logins.EmailAddressAndPassword |
None. |
Request Formats
application/json, text/json
Sample:
{ "ClientCode": "sample string 1", "DateTime": "2024-11-18T11:38:18.44804+08:00", "Content": { "EmailAddress": "sample string 1", "DeviceToken": "sample string 2", "DeviceInfo": "sample string 3", "Password": "sample string 4" } }
text/html
Sample:
{"ClientCode":"sample string 1","DateTime":"2024-11-18T11:38:18.44804+08:00","Content":{"EmailAddress":"sample string 1","DeviceToken":"sample string 2","DeviceInfo":"sample string 3","Password":"sample string 4"}}
application/xml, text/xml
Sample:
<Login xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CBSS_API.App_Code.Requests.Customers"> <ClientCode xmlns="http://schemas.datacontract.org/2004/07/CBSS_API.App_Code">sample string 1</ClientCode> <Content xmlns:d2p1="http://schemas.datacontract.org/2004/07/CBSS_API.Forms.Customers.Logins" xmlns="http://schemas.datacontract.org/2004/07/CBSS_API.App_Code"> <d2p1:DeviceInfo>sample string 3</d2p1:DeviceInfo> <d2p1:DeviceToken>sample string 2</d2p1:DeviceToken> <d2p1:EmailAddress>sample string 1</d2p1:EmailAddress> <d2p1:Password>sample string 4</d2p1:Password> </Content> <DateTime xmlns="http://schemas.datacontract.org/2004/07/CBSS_API.App_Code">2024-11-18T11:38:18.44804+08:00</DateTime> </Login>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Responses.Customers.LoginName | Description | Type | Additional information |
---|---|---|---|
IsSuccessful | boolean |
None. |
|
Messages | Collection of Models.Message |
None. |
|
ClientCode | string |
None. |
|
DateTime | date |
None. |
|
Content | Models.Customers.Login |
None. |
Response Formats
application/json, text/json
Sample:
{ "IsSuccessful": true, "Messages": [], "ClientCode": "sample string 2", "DateTime": "2024-11-18T11:38:18.5261631+08:00", "Content": null }
text/html
Sample:
{"IsSuccessful":true,"Messages":[],"ClientCode":"sample string 2","DateTime":"2024-11-18T11:38:18.5261631+08:00","Content":null}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.