Static API Keys are used by Affiliate Users to make requests to API V3. These cannot be generated if the "enable_affiliate_api" Preference is not enabled.
Name | Type | Description |
---|---|---|
api_key | String | This is the secret string the user presents in order to use the API key |
created | Datetime | The date this key was created |
id | Integer | ID of unique, auto-generated object for the key. This is NOT the secret part of the key that is passed in order to use it. This parameter is non-writable |
status | String | The status of the key. Only "active" keys can be used. When a key is created initially, its status is set based on the value of the "enable_affiliate_api" Preference. If the value of that preference is "auto" then the status is set to "active" immediately. Otherwise the status is set to "pending" by default.Show Supported Values |
updated | Datetime | The last time the key was updated, i.e. the last time its status was changed. |
user_id | Integer | ID of AffiliateUser object to which the key belongs to |
user_type | String | Identifies the account type of the user whose key this is. Currently only used by Affiliates.Show Supported Values |