API Function - Get User Hash

Back to API list

Use this service to get a user's hash key. This is a 32-character key which can be used instead of an email/password combination when calling any of the below API functions. It is designed to prevent having to store passwords in external applications. The user's hash key is valid until the user changes their email address or password.

URL /api/get_user_hash
Method POST
Parameters key - API Key
format - How to display output data. Valid values: xml, json, csv, tsv
callback - Optional JSONP callback function name
email - The user's logon email.
pass - The user's password.
Returns

Output data with fields:

  • N/A - 32 character hash key uniquely identifying and authenticating the user
  • Error Codes:

  • INVALIDKEY - The API Key is invalid
  • INVALIDUSERPASS - Invalid user email or password
  • Test Values

    API Key:
    Format:
    User email:
    User password:
    Test

    Test Results