Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iq2i/prestashop-webservice
A PHP library that let you interact with PrestaShop API
https://github.com/iq2i/prestashop-webservice
api library php prestashop webservice
Last synced: about 1 month ago
JSON representation
A PHP library that let you interact with PrestaShop API
- Host: GitHub
- URL: https://github.com/iq2i/prestashop-webservice
- Owner: IQ2i
- License: mit
- Created: 2021-04-28T08:48:16.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-04-19T13:57:46.000Z (over 2 years ago)
- Last Synced: 2024-11-13T11:58:03.047Z (about 2 months ago)
- Topics: api, library, php, prestashop, webservice
- Language: PHP
- Homepage:
- Size: 93.8 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PrestaShop API client
[](https://github.com/IQ2i/prestashop-webservice/actions/workflows/continuous-integration.yml)
[](https://scrutinizer-ci.com/g/IQ2i/prestashop-webservice/?branch=main)
[](https://scrutinizer-ci.com/g/IQ2i/prestashop-webservice/?branch=main)
A PHP client library to interact with PrestaShop API.
## Installation
```bash
composer require iq2i/prestashop-webservice
```
## Basic usage
1. Create a client instance:
```php
use IQ2i\PrestashopWebservice\Http\Client;
$client = new Client([
'url' => 'https://my-prestashop.com/api/',
'key' => '6MBWZM37S6XCZXYT81GD6XD41SKZ14TP',
]);
```
2. Create a request:
```php
use IQ2i\PrestashopWebservice\Http\Request\GetRequest;
/** GET /api/categories/1 */
$request = new GetRequest('categories', 1);
```
3. Execute request
```php
$response = $client->execute($request);
```
4. Use client's response:
```php
$statusCode = $response->getStatusCode();
$header = $response->getHeaders();
$content = $response->getContent();
```
The response's content is an array, client automatically decode XML.
## A request for each action
```php
use IQ2i\PrestashopWebservice\Http\QueryAttribute\Schema;
use IQ2i\PrestashopWebservice\Http\Request\SchemaRequest;
/** GET /api/categories?schema=synopsis */
$request = new SchemaRequest('categories');
$request->addQueryAttribute(new Schema(Schema::SYNOPSIS))
```
```php
use IQ2i\PrestashopWebservice\Http\Request\ListRequest;
/** GET /api/categories */
$request = new ListRequest('categories');
```
```php
use IQ2i\PrestashopWebservice\Http\Request\GetRequest;
/** GET /api/categories/1 */
$request = new GetRequest('categories', 1);
```
```php
use IQ2i\PrestashopWebservice\Http\Request\CreateRequest;
/** POST /api/categories */
$request = new CreateRequest('categories');
$request->setBody('XML content');
```
```php
use IQ2i\PrestashopWebservice\Http\Request\UpdateRequest;
/** PUT /api/categories/1 */
$request = new UpdateRequest('categories', 1);
$request->setBody('XML content');
```
```php
use IQ2i\PrestashopWebservice\Http\Request\DeleteRequest;
/** DELETE /api/categories/1 */
$request = new DeleteRequest('categories', 1);
```
## Use query attributes
PrestaShop defines list options for webservice: https://devdocs.prestashop.com/1.7/webservice/cheat-sheet/#list-options
These options are available in this library:
```php
use IQ2i\PrestashopWebservice\Http\QueryAttribute\Schema;
/** GET /api/categories?schema=synopsis */
$request = new SchemaRequest('categories');
$request->addQueryAttribute(new Schema(Schema::SYNOPSIS));
```
```php
use IQ2i\PrestashopWebservice\Http\QueryAttribute\Filter;
use IQ2i\PrestashopWebservice\Http\QueryAttribute\Sort;
/** GET /api/categories?filter[name]=%[clothes]&sort=[name_ASC] */
$request = new ListRequest('categories');
$request->addQueryAttribute(new Filter('name', 'clothes', Filter::END));
$request->addQueryAttribute(new Sort('name', Sort::ASC));
```
## Issues and feature requests
Please report issues and request features at https://github.com/iq2i/prestashop-webservice/issues.
## License
This bundle is under the MIT license.
For the whole copyright, see the [LICENSE](LICENSE) file distributed with this source code.