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

Class	Method	HTTP request	Description
ProductReferencesApi	productReferencesGet	GET /api/storefront/v1/product-references/ext/{reference}	Returns a storefront product reference.
ProductReferencesApi	productReferencesGetAll	GET /api/storefront/v1/product-references/ext	Returns all storefront product references relevant to the specified query parameters.
ProductReferencesApi	productReferencesGetAllProductLinks	GET /api/storefront/v1/product-references/ext/product-links	Returns a list of product links associated with storefront product references relevant to the specified query parameters.
ProductReferencesApi	productReferencesGetProduct	GET /api/storefront/v1/product-references/ext/{reference}/product	Returns a product by storefront product reference.
ProductReferencesApi	productReferencesGetProductCostDetails	GET /api/storefront/v1/product-references/ext/{reference}/product-cost-details	Returns a product cost details from ecommerce system.
ProductReferencesApi	productReferencesGetProductFilter	GET /api/storefront/v1/product-references/ext/{reference}/product-filter	Returns a product filter by storefront product reference.
ProductReferencesApi	productReferencesGetProductLink	GET /api/storefront/v1/product-references/ext/{reference}/product-link	Returns a product link by storefront product reference.
ProductReferencesApi	productReferencesGetProductPersonalizationWorkflow	GET /api/storefront/v1/product-references/ext/{reference}/product-personalization-workflow	Returns a product personalization workflow configuration by storefront product reference.
ProductReferencesApi	productReferencesObsoleteGetProduct	GET /api/storefront/v1/product-references/{reference}/product	Returns a product by storefront product reference.
ProductReferencesApi	productReferencesObsoleteGetProductFilter	GET /api/storefront/v1/product-references/{reference}/product-filter	Returns a product filter by storefront product reference.
ProductReferencesApi	productReferencesObsoleteGetProductLink	GET /api/storefront/v1/product-references/{reference}/product-link	Returns a product link by storefront product reference.
ProductReferencesApi	productReferencesObsoleteGetProductPersonalizationWorkflow	GET /api/storefront/v1/product-references/{reference}/product-personalization-workflow	Returns a product personalization workflow configuration by storefront product reference.
ProductsApi	productsGetAllProductOptions	GET /api/storefront/v1/products/options	Returns a list of product options for all products.
ProductsApi	productsGetAllProducts	GET /api/storefront/v1/products	Returns all products, relevant to the specified query parameters.
ProductsApi	productsGetAvailableProductTags	GET /api/storefront/v1/products/available-tags	Returns a list of all available product tags.
ProductsApi	productsGetProduct	GET /api/storefront/v1/products/{id}	Returns a product by identifier.
ProductsApi	productsGetProductFilter	GET /api/storefront/v1/products/{id}/filters/{productFilterId}	Returns a product filter.
ProductsApi	productsGetProductFilters	GET /api/storefront/v1/products/{id}/filters	Returns a list of product filters.
ProductsApi	productsGetProductLink	GET /api/storefront/v1/products/{id}/links/{productLinkId}	Returns a product link.
ProductsApi	productsGetProductLinks	GET /api/storefront/v1/products/{id}/links	Returns a list of product links.
ProductsApi	productsGetProductOptions	GET /api/storefront/v1/products/{id}/options	Returns a list of product options.
ProductsApi	productsGetProductVariant	GET /api/storefront/v1/products/{id}/variants/{productVariantId}	Returns a product variant.
ProductsApi	productsGetProductVariantDesigns	GET /api/storefront/v1/products/{id}/variant-designs	Returns a list of product variant designs.
ProductsApi	productsGetProductVariantMockups	GET /api/storefront/v1/products/{id}/variant-mockups	Returns a list of product variant mockups.
ProductsApi	productsGetProductVariants	GET /api/storefront/v1/products/{id}/variants	Returns a list of product variants.
ProductsApi	productsSetProductVariantPrice	POST /api/storefront/v1/products/{id}/set-variant-price	Set product variant price.
ProductsApi	productsUpdateProductVariantResources	POST /api/storefront/v1/products/{id}/update-variant-resources	Updates product variant resources.

aurigma / php-storefront-products-client

Maintainers

Details