MyPW Developer Resources

API Method: auth.auth


The primary function used to validate a MyPW token/value pair.

Request Parameters


siteid (Required)
    Your MyPW site identifier.

authkey (Required)
    Your MyPW authentication key.

tokenid (Required)
    The unique identifier for the token you are checking.

tokenvalue (Required)
    The value which you wish to validate.

userip (Recommended)
    The IP address of the user attempting to authentication (usually retrieved using the REMOTE_ADDR server variable).

sitename (Optional)
    Allows you to override the default sitename for your account. You may want to use this if you run multiple websites under one MyPW site account, or use it for billing purposes.

note (Optional)
    Optional field for additional information about this transaction. Visible to both you and the user when viewing activity logs on MyPW.com


Response Parameters


code
    a numeric response code. 0=success, all other numbers are failures (see below)

message
    a text description of the result

validate
    a message digest to validate this response, sha512 base64 of the following fields together without spaces "SECRET TOKENID TOKENVALUE AUTHKEY"


Response Codes


-99: Site authentication failed (Invalid siteid / authkey)
 -2: Token disabled
 -1: Token not found
  0: Token successfully validated
all others: Validation failed. See message for details.


Google Groups Beta
Subscribe to MyPW Developers
Email:
Visit this group
Have you created a bit of code that might be of interest to other MyPW developers? Post it on MyPW google groups.