auth/plain

The following methods are supported on this resource:

Mount Points

The following URLs are examples of where this resource is mounted :

XML: http://api.hi5.com
*JSON: http://api.hi5.com
*JSON endpoints are mounted read-only.

update

Authenticate a user by their email address/password.

This is the simplest way to obtain an authentication token. For full functionality you will probably want to use a more secure method of authentication in the future.

This method will return an authentication token when given valid credentials.

The Hi5AuthToken allows for access to authenticated API calls. You can supply this token by adding it to the query string as the Hi5AuthToken parameter or by setting a cookie named Hi5AuthToken.

The response to this method will also return a Set-Cookie header with a correctly configured Hi5AuthToken cookie.

The following form will allow you to set the authentication cookie:

Username:
Password:
API Key:

Possible HTTP Parameters

name description
api_key you api key for your widget
username The username.
password The password.

Output Payload

The authentication token.

Errors

code description
403 If authentication failed.

Comments