Authentication

LibraryH3lp supports two types of authentication, cookie-based and HTTP basic auth. Both types use HTTPS only. To ensure credential privacy, unencrypted HTTP is not supported.

Basic HTTP auth

Under development.

Cookie-based

LibraryH3lp supports cookie-based authentication over HTTPS.

Authentication URI

/2011-12-03/auth/login

HTTP GET

Not supported.

HTTP POST

Allows you to obtain an authentication cookie to be included in subsequent API requests.

Required Parameters

You must POST the following parameters:

Parameter Description
username String containing the username of the user account that you wish to use for subsequent API calls.
password String containing the password corresponding to the username.

Response

Returns a JSON response with the following properties. If successful, the response will contain a session cookie to be used in subsequent API requests.

Property Description
success Boolean indicating if the request was successful.
username Optional. If success is true, username is a string containing the username of the successfully authenticated user.
message Optional. If success is null, message is a string describing the reason for the failed request.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.