aurigma / php-storefront-products-client
PHP API Client for Storefront Products API service of Customer's Canvas web-to-print system.
Requires
- php: ^7.4 || ^8.0
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^7.3
- guzzlehttp/psr7: ^1.7 || ^2.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.5
- phpunit/phpunit: ^8.0 || ^9.0
This package is auto-updated.
Last update: 2024-11-30 10:02:14 UTC
README
======================================================
This module is a PHP API client for Storefront Products API service which is a part of Customer's Canvas web-to-print system. It is supposed that you are familiar with its services and understand how to use its APIs. To learn more about Customer's Canvas and its services, refer the Getting Started section of its documentation.
Pre-requisites
To be able to use this package, you need to meet the following requirements:
- You must have an account at Customer's Canvas.
For other platforms, see the Backend services article in Customer's Canvas documentation.
Installation
composer require aurigma/php-storefront-products-client
Requirements
PHP 7.2 and later.
Composer
To install the bindings via Composer, add the following to composer.json
:
{ "repositories": [ { "type": "vcs", "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" } ], "require": { "GIT_USER_ID/GIT_REPO_ID": "*@dev" } }
Then run composer install
Manual Installation
Download the files and include autoload.php
:
<?php require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');
Getting Started
Please follow the installation procedure and then run the following:
<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: apiKey $config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer'); // Configure API key authorization: bearerAuth $config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer'); // Configure OAuth2 access token for authorization: oauth2-clientCredentials $config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); // Configure OAuth2 access token for authorization: oauth2-code $config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); // Configure OAuth2 access token for authorization: oauth2-implicit $config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); $apiInstance = new Aurigma\Storefront\Products\Api\ProductReferencesApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $reference = 'reference_example'; // string | Product reference - external reference to Customer's Canvas products, e.g online store product identifier. $storefront_id = 56; // int | Storefront identifier. $tenant_id = 56; // int | Tenant identifier. try { $result = $apiInstance->productReferencesGet($reference, $storefront_id, $tenant_id); print_r($result); } catch (Exception $e) { echo 'Exception when calling ProductReferencesApi->productReferencesGet: ', $e->getMessage(), PHP_EOL; }
Tests
To run the tests, use:
composer install vendor/bin/phpunit
Author
Aurigma Inc info@aurigma.com (https://customerscanvas.com)
API Endpoints
All URIs are relative to http://localhost
Models
- AppearanceDataDto
- AppearanceDataItemDto
- AppearanceDataType
- ImageInfo
- MicrosoftAspNetCoreMvcProblemDetails
- OptionType
- PagedOfProductDto
- PagedOfProductFilterDto
- PagedOfProductLinkDto
- PagedOfProductOptionDto
- PagedOfProductReferenceDto
- PagedOfProductVariantDesignDto
- PagedOfProductVariantDto
- PagedOfProductVariantMockupDto
- ProductCostDetailsDto
- ProductDto
- ProductFilterDto
- ProductFilterOptionDto
- ProductFilterType
- ProductLinkDto
- ProductOptionDto
- ProductOptionValueDto
- ProductReferenceDto
- ProductVariantDesignDto
- ProductVariantDto
- ProductVariantMockupDto
- ProductVariantMockupType
- ProductVariantOptionDto
- ProductVariantResourceDto
- ProductVariantResourcePreview
- ProductVariantResourceType
- SetProductVariantPriceDto
- SimpleOptionValue
- SurfaceUsageType