Overview
The MyPW API allows you to authenticate MyPW devices, as well as perform other actions related to your MyPW site account.
To perform an action using the MyPW API, you simply send a request to the endpoint of your choosing, specifying the method you wish to call, the required arguments, and any optional arguments, and will receive a response back formatted appropriately for the chosen endpoint.
All requests require a method name, as well as a list of named parameters, which must include the following required parameters.
| REQUIRED PARAMETERS |
| siteid |
your MyPW site id. |
| authkey |
your API authentication key. |
| tokenid |
The unique identifier for the token you are checking. |
| tokenvalue |
The value which you wish to validate. |
| OPTIONAL PARAMETERS |
| userip |
The IP address of the user attempting to authentication. |
| sitename |
Allows you to override the default sitename for your account. |
| note |
Optional field for additional information about this transaction. Visible to both you and the user when viewing activity logs on MyPW.com
|
In addition, each method may have additional required and optional parameters.
For more information about the parameters and return values for each method, please refer to the API documentation for that method.
|