{"id":22215,"date":"2018-10-27T11:46:14","date_gmt":"2018-10-27T11:46:14","guid":{"rendered":"https:\/\/www.knowband.com\/blog\/?p=22215\/"},"modified":"2024-06-04T06:00:38","modified_gmt":"2024-06-04T06:00:38","slug":"create-prestashop-module-web-service-api","status":"publish","type":"post","link":"https:\/\/www.knowband.com\/blog\/prestashop-tutorials\/create-prestashop-module-web-service-api\/","title":{"rendered":"How to create Prestashop Module Web Service API?"},"content":{"rendered":"

This blog is all about how to create and use the Prestashop Webservices API. Prestashop has default Web Services tool available which allows accessing the store from remote applications.<\/p>\n

Prerequisites<\/h2>\n
    \n
  1. You Prestashop store should have “module rewrite” enabled for apache.<\/li>\n
  2. It is preferable to use SSL (https:) for web service calls, as it avoids the “man in the middle” type security issues.<\/li>\n
  3. Check that the five methods GET, POST, PUT, DELETE and HEAD are supported on the server.<\/li>\n<\/ol>\n

    To ensure the security and efficiency of your Prestashop Web Services, it’s essential to use SSL (HTTPS) for all web service calls. This prevents “man in the middle” attacks, safeguarding your data during transmission. Additionally, verifying that your server supports the HTTP methods GET, POST, PUT, DELETE, and HEAD is crucial for seamless operation. By configuring these settings, you optimize your store’s performance and security, ensuring reliable access and management of your Prestashop resources through the API.<\/p>\n

    How to configure Web Services in the Prestashop?<\/h2>\n

    \"Step<\/a><\/p>\n

    1. Login into the Prestashop Back-office.<\/p>\n

    2. Navigate to\u00a0Advance Parameters -> Web Services menu options to open the Web Services page.<\/p>\n

    \"Open<\/a><\/p>\n

     <\/p>\n

    3. It will redirect to the Web Services page having the listing of available Web Services and the configuration form to configure the service.<\/p>\n

    4. The Configuration form has the following fields:<\/p>\n

    \"configuration<\/a><\/p>\n

    a) Enable Prestashop\u2019s web service<\/strong>: Enable the setting to use web service in the Prestashop Store.<\/p>\n

    b) Enable CGI mode for PHP<\/strong>: Enable the setting to use PHP as CGI script instead of Apache module.<\/p>\n

    5. Click on the Save button to save the configuration. Now, you can use the Web Services in your Prestashop Store.<\/p>\n

    How to add\/Update Web Services in the Prestashop?<\/h2>\n

    \"Knowband<\/a><\/p>\n

    1. Login into the Prestashop Back-office<\/p>\n

    2. Navigate to Advance Parameters -> Web Services menu options to open the Web Services page.<\/p>\n

    3. It will redirect to the Web Services page having a listing of available Web Services.<\/p>\n

    \"Web<\/a><\/p>\n

    4.\u00a0Click on the \u201cAdd new web service key\u201d button to add new web service key to access only to the certain resources of the Prestashop store.<\/p>\n

    \"Add<\/a><\/p>\n

    a) Key<\/strong>: This is a unique key. You can enter it manually or click on the Generate button to generate a random key for the Prestashop web service.<\/p>\n

    b) Key Description<\/strong>: You can provide the description regarding the key for better understanding.<\/p>\n

    c) Status<\/strong>: Enable the key to provide a grant to access the data using the key.<\/p>\n

    d) Permission<\/strong>: Provide the permission to access the data using the certain key. You can check the specific permission to grant access of the data like Add, Edit, delete or view. Here, we have checked the permission to Countries and Currency.<\/p>\n

    5. Click on the Save button to add the key to the web services.<\/p>\n

    How to the access the Web Service?<\/h2>\n

    Once you have created the key for the web service and properly configured, you need to hit the following URL in your browser:<\/p>\n

    https:\/\/{store root path}\/api\/<\/p>\n

    It will prompt you for username and password to access the resource.<\/p>\n

    \"sign-in<\/a><\/p>\n

    a) Username:<\/strong> Enter the key of the web service which is generated in the above step. For Example MWMHJVB9PBYBNYBSFTQ8ZXRCM43FQ2MW<\/p>\n

    b) Password:<\/strong> It should be blank as no password required.<\/p>\n

    After sign in, you will access the list of the resources and all permitted CRUD options that you have configured in your Prestashop Store.<\/p>\n

    \"xml-file\"<\/a><\/p>\n

    You are now successfully connected to the Prestashop web service.<\/p>\n

    a) To GET the list of entities for a particular resource:<\/strong><\/p>\n

    https:\/\/shop_root_url\/api\/resouce<\/a><\/p>\n

    Example: https:\/\/www.knowband.com\/api\/customers to get a list of all customers.<\/p>\n

    b) To GET a specific customer by ID:<\/strong><\/p>\n

    https:\/\/shop_root_url\/api\/customers\/1<\/a><\/p>\n

    For Example: To get the detail of customer having ID 10<\/p>\n

    https:\/\/www.knowband.com\/api\/customers\/10<\/p>\n

    Recommend Watch:\u00a0<\/strong><\/p>\n