Now. store owners can give access to the third party to use their marketplace database through CRUD API. Prestashop Marketplace Web Service API will help them with that.
Furthermore, users can now use the GET, POST, PUT and DELETE methods on Prestashop Marketplace Module tables using Core Prestashop Webservice API.
- This module is an add-on for Marketplace Module. Therefore, to use this module, you need to install Prestashop Advanced Multi Vendor Marketplace first.
- The “API access document” will be available only if you have purchased the “Prestashop Advance Marketplace” module. After that, admin needs to contact us through our ticket system to have the “API access documents”.
- A seller can create Auth Key to access their own Marketplace Details
- Admin has access to manage seller auth key permissions
- Seller and Admin can manage access to every resource permission
- View (GET) Marketplace sellers details using REST API
- View, add, update and delete Marketplace seller’s products
- View Marketplace Seller’s Orders (Add and Update is not fully functional)
- Go to Module Manager in Back office and click on ‘upload a module’.
- After that, Drag and drop the module file or select the file from the system.
- In this way, the module installation will be successful.
How to configure the module
On the configuration page, currently you can allow sellers to create web service request.
Activate the PrestaShop WebService API
Firstly, the admin needs to activate Prestashop Webservice API.
To do so, go to Advanced Parameters section and then to Webservice tab.
1: After that, enable the PrestaShop Webservice from the configuration page.
2: Then, click on “Add new webservice key” button to add a new key,
3: Finally, add an API key. Thus, it is advised to generate a random key as well for the security purpose. Add a description, activate the status, and then give all permissions to the marketplace “seller” resource.
Follow the process of Prestashop API and then you can see the Marketplace Database API
Process to create seller’s authentication key
Moving further, now seller needs to create an authentication key to access the web service API.
In order to create authentication key, go to “Webservice” tab available under my account section.
After that, proceed to add a new authentication key.
Moreover, on create authentication page, seller can see the form to generate the web service API key.
The seller can generate an authentication key & can also add the description. They can also manage status (if admin allows) and manage permission for multiple marketplace resources.
Above all, remember that resources allowed for sellers are accessible by the endpoint URL.
Manage authentication key at admin’ end
After installing the Marketplace Webservice module, finally a new tab adds to the Marketplace tab.
This is where admin can also create and manage the seller authentication key. In other words, this new tab contains settings of webservice.
After that, go to manage webservice” tab available under marketlpace.
Click on the ‘Add New’ button to open the form. After that, here you can select a seller and provide an Authentication key.
Marketplace Webservice URL with Auth Key
Firstly, you need to access the URL with the PrestaShop ws_key. Then only sellers can access the Marketplace API using the ‘auth_key’ parameter added in the URL.
For that reason, this ‘auth_key’ is the identifier to get the particular seller information.
Complete URL: domain/api/seller?auth_key=PFTVH97CEI&ws_key=IP2LASMH7W5N6T8PB<br>
Seller API details
Get the seller details
Endpoint : /api/seller/sellerinfo
Seller Product API
1: Get the seller product details
Endpoint : /api/seller/sellerproduct
2: Create seller product
Endpoint : /api/seller/saveproduct
3: Delete seller product
Endpoint : /api/seller/deleteproduct
Seller Order API
1: Get the seller order details
Endpoint : /api/seller/sellerorder
2: Create order for the seller
Endpoint : /api/seller/createorder
Seller Images API
1: Get the list of types of images
Endpoint : /api/seller/mpimages
2: Get the logo of the seller
Endpoint : /api/seller/mpimages/sellerlogo
3: Get the banner of the seller
Endpoint : /api/seller/mpimages/sellerbanner
4: Get the Shop Logo
Endpoint : /api/seller/mpimages/shoplogo
5: Get the Shop Banner
Endpoint : /api/seller/mpimages/shopbanner
6: Get list of product images available
Endpoint : /api/seller/mpimages/products
7: Get list of images for a particular product
Endpoint : /api/seller/mpimages/products/[id_product]
8: Get a particular image of a product
Endpoint : /api/seller/mpimages/products/[id_product]/[id_image]
9: Finally, Upload the seller image by creating a form similar to the PrestaShop default API. And therefore to know more, go through this documentation.
So, this was all about Prestashop Marketplace Web Service API Configuration Module. Finally, I hope this document will help you in checking the functionality of the module in a better way. Furthermore, do let us know about your views in the comments.
For any kind of technical assistance, just raise a ticket at http://webkul.uvdesk.com and for any doubt contact us at email@example.com
Current Product Version - 6.0.0
Supported Framework Version - 1.7