| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| v:2.0:api [2019/01/04 20:50] – [Subscriptions] marija | v:2.0:api [2022/08/12 16:42] (current) – foxybrett |
|---|
| ====== The FoxyCart API ====== | ====== The FoxyCart API ====== |
| |
| <WRAP TIP> | <WRAP important> |
| __**NOTE: This XML API will be deprecated**__ | //**NOTE: This XML API will be deprecated**// |
| Though this legacy XML API works and will continue to function in the future, it will not see any new functionality. We recommend any new integrations are built on top of our new Hypermedia API: https://api.foxycart.com/ | Though this legacy XML API works and will continue to function in the future, it will not see any new functionality. We recommend any new integrations are built on top of our new Hypermedia API: https://api.foxycart.com/ |
| </WRAP> | </WRAP> |
| | |
| ===== Before You Get Started With the API ===== | ===== Before You Get Started With the API ===== |
| | |
| | <WRAP alert> |
| | //**NOTE: Please use our newer API**// |
| | This page is documentation for our legacy XML API. Please use our new API: [[https://api.foxycart.com/]] |
| | </WRAP> |
| | |
| Like any API, FoxyCart's API is geared towards advanced users only. If you're not comfortable with programming, you should probably get familiar with your language of choice first or look for professional assistance. Never test on a live store, as you can certainly create problems that could impact your customers or your revenue. | Like any API, FoxyCart's API is geared towards advanced users only. If you're not comfortable with programming, you should probably get familiar with your language of choice first or look for professional assistance. Never test on a live store, as you can certainly create problems that could impact your customers or your revenue. |
| |
| 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. |
