Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision |
| v:2.0:api [2017/08/16 04:11] – [Transactions] adam | v:2.0:api [2019/05/01 02:00] – [Connecting to the API] adam |
|---|
| FoxyCart's API is partially RESTful, but for security reasons only supports ''POST'' requests at this point. **''GET''** requests are //NOT// supported, which cuts down on potential security risks (particularly with regard to how ''GET'' requests tend to get logged, cached, stored, and etc.). | FoxyCart's API is partially RESTful, but for security reasons only supports ''POST'' requests at this point. **''GET''** requests are //NOT// supported, which cuts down on potential security risks (particularly with regard to how ''GET'' requests tend to get logged, cached, stored, and etc.). |
| |
| The endpoint URL for your FoxyCart store will look like ''https://example.foxycart.com/api'' or ''https://secure.example.tld/api'', depending on what your FoxyCart store URL is set to. All requests need the ''api_token'' passed in along with any request. Your API Token is the same as your datafeed encryption key, and can be set in the Advanced tab in your FoxyCart admin. | The endpoint URL for your FoxyCart store will look like ''https://example.foxycart.com/api'' or ''https://secure.example.tld/api'', depending on what your FoxyCart store URL is set to. All requests need the ''api_token'' passed in along with any request. The API key is available from the “advanced” settings page in the FoxyCart administration, from the [[v:2.0:store_secret|"store secret" value]]. |
| |
| <wrap important>It is your responsibility to keep this key secure.</wrap> If a malicious person finds your API key they will have access that they definitely should //not// have. | <wrap important>It is your responsibility to keep this key secure.</wrap> If a malicious person finds your API key they will have access that they definitely should //not// have. |
| ; ''subscription_list'' | ; ''subscription_list'' |
| : **Filter Options:** | : **Filter Options:** |
| * ''is_active_filter'' | * ''is_active_filter'' - the default is active. Use ''0'' for inactive and a blank string ''""'' for all. |
| * ''frequency_filter'' | * ''frequency_filter'' |
| * ''past_due_amount_filter'' (if you include this filter and give it a value (such as ''1'') it will return subscriptions with past due amounts greater than 0) | * ''past_due_amount_filter'' (if you include this filter and give it a value (such as ''1'') it will return subscriptions with past due amounts greater than 0) |
