POST v1/Authenticate
Authenticates a user
URI template
v1/AuthenticateRequest Information
URI Parameters
None.
Body Parameters
InLogin object containing a user's email and password
InLoginName | Description | Type | Additional information |
---|---|---|---|
string |
Required |
||
Password | string |
Required |
Request Formats
application/json, text/json
Sample:
{ "Email": "sample string 1", "Password": "sample string 2" }
application/xml, text/xml
Sample:
<InLogin xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Inbound"> <Email>sample string 1</Email> <Password>sample string 2</Password> </InLogin>
Response Information
Resource Description
The customer id of the authenticated customer
globally unique identifierResponse Formats
application/json, text/json
Sample:
"fafc09da-5f8b-4ed1-b1e8-b9006c2dcd6d"
{Results of your json query will appear here}
application/xml, text/xml
Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">fafc09da-5f8b-4ed1-b1e8-b9006c2dcd6d</guid>