Login
Description
Login a user.
Method
URL: https://api.free2convey.co.uk/token
Type: POST
Content Type: application/x-www-form-urlencoded
Input parameters
Name Type Size Description Mandatory
userName string 256 The user name Yes
password string 128 The password Yes
grant_type string 128 Always has the same value: password Yes
Input example
userName&=user@domain.co.uk&password=Password01#&grant_type=password
Output
Name Type Description
access_token string The authentication token
token_type string The bearer string
expires_in int Expire in
userName string The user name
.issued DateTime The time when you accessed
.expires DateTime The expiration time
Output example
{
    "access_token":"ZnZQKRFR9NQ82ZrDbjOHy71Ko2OcjDxnBhh9i-tpfsPOfG19THLajm1u10KXANV3ZWbGFTA0ny0e12f0JM5Y2Q3Hy_4VRGcH6NwGGzrIhEEVxDqexIWo0jiu-Wx9rlOk8baGbQVqkX9yb33kqbqBIbhjiGPRiqZf6hqXDpP1_fuBF-xziQtv2-3RR62TXY8NJmCvMngZvp_MgNSpOCJo232mpIeD9baskpjc0Xz8W8Tav9c811Q-LMJswxgmhfar17mJ2-gtpQY9mEvQ1JqhXkvxSPUq2lhJ-AeX3jAwJbL-zXbSeubQo5s6onyl1ErWEm46zhPJAdCrHxzRFkCejjzTpD-ItMtJtFgjEeJd4FBrczlQXg8rGHcvcpUWm1dCMgV2k6SPSTEO3l-QJQMnN9RYjUPMYSniAxEolv63YipNi-JQ6X3ZR-w5qbBapFVilz4258RDZp35j8IPVqlyTEohjLGR-9LAqReet_dSgl3YsvQbBcKFT9WMF4aEPgtrWTP26BMktL9Y7C7l631w",
    "token_type":"bearer",
    "expires_in":1209599,
    "userName":"user@domain.co.uk",
    ".issued":"Wed, 07 Oct 2015 09:19:41 GMT",
    ".expires":"Wed, 21 Oct 2015 09:19:41 GMT"
}
            
Logout
Description
Destroy the authentication for a given user.
Method
URL: https://api.free2convey.co.uk/api/Account/Logout
Type: POST
Headers: { Authorization: 'Bearer ' + access_token }
Input parameters
input parameters: none
Output
Output result: void