https://github.com/jupi007/prestashop-webservice-bundle

Symfony integration of PrestaShop Webservice lib (Extra)
https://github.com/jupi007/prestashop-webservice-bundle

api prestashop prestashop-1-7 prestashop-webservice symfony symfony-bundle

Last synced: 2 months ago
JSON representation

Symfony integration of PrestaShop Webservice lib (Extra)

• Host: GitHub
• URL: https://github.com/jupi007/prestashop-webservice-bundle
• Owner: Jupi007
• License: mit
• Created: 2021-05-02T19:47:08.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-03-14T11:56:31.000Z (almost 3 years ago)
• Last Synced: 2024-10-10T00:41:55.855Z (2 months ago)
• Topics: api, prestashop, prestashop-1-7, prestashop-webservice, symfony, symfony-bundle
• Language: PHP
• Homepage:
• Size: 76.2 KB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Jupi PrestaShop Webservice (Extra) Bundle


Symfony integration of [PrestaShop Webservice lib](https://github.com/PrestaShop/PrestaShop-webservice-lib) and [PrestaShop Webservice lib Extra](https://github.com/Jupi007/prestashop-webservice-extra).

Installation

============

Make sure Composer is installed globally, as explained in the

[installation chapter](https://getcomposer.org/doc/00-intro.md)

of the Composer documentation.

Applications that use Symfony Flex

----------------------------------

Open a command console, enter your project directory and execute:

```console

$ composer require "jupi/prestashop-webservice-bundle"

```

Applications that don't use Symfony Flex

----------------------------------------

### Step 1: Download the Bundle

Open a command console, enter your project directory and execute the

following command to download the latest stable version of this bundle:

```console

$ composer require "jupi/prestashop-webservice-bundle"

```

### Step 2: Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles

in the `config/bundles.php` file of your project:

```php

// config/bundles.php

return [

    // ...

    Jupi\PrestaShopWebserviceBundle\JupiPrestaShopWebserviceBundle::class => ['all' => true],

];

```

Configuration

=============

Prerequisites

-------------

First at all, you must enable the webservice feature of your PrestaShop store and create an API key access. Please have a look at the official doc: [Creating access to the Webservice](https://devdocs.prestashop.com/1.7/webservice/tutorials/creating-access/).

---

It is recommended to fill secret infos like API keys into `.env.local` file.

To do this, create a `config/packages/jupi_presta_shop_webservice.yaml`:

```yaml

jupi_presta_shop_webservice:

  connection:

    store_root_path: '%env(PRESTA_WEBSERVICE_ROOT_PATH)%'

    authentication_key: '%env(PRESTA_WEBSERVICE_AUTH_KEY)%'

```

And then add these environment variables to your `.env.local`:

```

PRESTA_WEBSERVICE_ROOT_PATH=https://absolute-path-to-your-store.com

PRESTA_WEBSERVICE_AUTH_KEY=ABCDEFGHIJKLMNOPQRSTUVWXYZ123456789

```

Usage

=====

Just inject the service by type-hinting an argument with the `Jupi\PrestaShopWebserviceBundle\Services\PrestaShopWebservice` or `PrestaShopWebserviceExtra` class:

```php

// src/Controller/ProductController.php

namespace App\Controller;

use Jupi\PrestaShopWebserviceBundle\Services\PrestaShopWebservice;

// or

use Jupi\PrestaShopWebserviceBundle\Services\PrestaShopWebserviceExtra;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;

use Symfony\Component\HttpFoundation\Response;

use Symfony\Component\Routing\Annotation\Route;

class ProductController extends AbstractController

{

    #[Route('/products', name: 'products')]

    public function list(PrestaShopWebservice $psWebservice): Response

    {

        $products = $psWebservice->get(['resource' => 'products']);

        // ...

    }

    // or

    #[Route('/products', name: 'products')]

    public function list(PrestaShopWebserviceExtra $psWebservice): Response

    {

        $products = $psWebservice->get('products')

                                 ->executeQuery();

        // ...

    }

}

```

Once you have a `PrestaShopWebservice` or `PrestaShopWebserviceExtra` instance, you can use it just like the normal corresponding library.

See the official documentation for more informations: https://devdocs.prestashop.com/1.7/webservice/tutorials/prestashop-webservice-lib/

And also the [PrestaShop Webservice lib Extra](https://github.com/Jupi007/prestashop-webservice-extra) repository.