How to start your integration with API2Cart
API2Cart provides a single API to integrate with many shopping platforms, including industry leaders like Shopify, Magento, WooCommerce, Bigcommerce, Volusion, PrestaShop, OpenCart, and others.
The API is accessed over HTTPS protocol and is available for authenticated users only. It is based on the RESTful principles, which makes it easier to test and implement.
1. How to start your work with API2Cart
Firstly, you need to register an account. In your account you will find your unique API key. It is a code generated by API2Cart for each user individually. It provides you with access rights on the API. You will use your API key to establish a connection between the service and stores you are going to work with. Personal API Key helps us to identify users who perform API requests and allows to track and control API usage.
To be able to communicate with store data you need to add that store to your API2Cart account.
The process of connecting a store depends on a type of eCommerce platform:
You can add your store manually to the list by clicking the “Add store” button in your API2Cart account. Paste your store’s URL, select the store’s type, and enter the needed information that depends on the chosen store type. You will have to provide API Key/Token and password if it is a hosted platform or use bridge files to establish a connection to other carts. See the full list of requirements for different platforms here.
Also, you can add the store automatically via API request using account.cart.add method with the same credentials described above.
You can send a request via Postman or visit our Interactive Docs.
Here is a short video guide on how to do it in a few clicks
Stores based on Shopify or Bigommerce may be added via OAuth. Find more details here.
To connect stores that are based on open-source shopping platforms like Magento, WooCommerce, PrestaShop, and CS-Cart and others we use the Connection Bridge file.
There are two ways you can install Bridge file on the store:
You can download plugins for needed platforms in the “Build Plugin” section on your API2Cart account.
Please find our guides on how to get needed credentials on different platforms here.
Note: API2Cart works on the back-end of your system. It means that your customers do not need to interact with API2Cart. To establish the connection with their stores you can provide a UI in your application where your customer can download the plugin and provide needed credentials.
2. Getting Started with API
Before starting work with API explore our documentation.
For testing purposes, you can execute needed methods via our Interactive Docs, from your account or via Postman.
To make it easier for you to navigate your integration logic based on our API, we outlined general patterns that work for software of particular industries. Click here to read the details.
Also, you can find some patterns to work with different entities:
API2Cart webhook is a mechanism for getting notifications when some changes or events on shopping carts occur. For example, the order.update webhook triggers every time when the order status changes. In this case, the JSON formatted data is being sent to the specified URL.
You can check which events you can work with via webhooks here.