<back to all web services
LoginUser
The following routes are available for this service:| GET,OPTIONS | /login | Logs in a user by using the given credentials to get a valid auth token. | |
|---|
LoginUser Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Email | query | string | Yes | The email address of the user. |
| Password | query | string | Yes | The password of the user. |
LoginResponse Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| AuthToken | form | string | No | |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
HTTP + JSV
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
GET /login HTTP/1.1
Host: api.paylock.com
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
authToken: String
}