aurigma/php-backoffice-client

PHP API Client for BackOffice API service of Customer's Canvas web-to-print system.

1.0.0 2025-08-07 11:58 UTC

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

proprietary

• Aurigma Inc

• backoffice
• api client
• web-to-print
• customers canvas

README

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

This module is a PHP API client for BackOffice 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-backoffice-client

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

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');




$apiInstance = new Aurigma\BackOffice\Api\BuildInfoApi(
    // 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()
);

try {
    $result = $apiInstance->buildInfoGetInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BuildInfoApi->buildInfoGetInfo: ', $e->getMessage(), PHP_EOL;
}

Author

Aurigma Inc [e-mail] (https://customerscanvas.com)

API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
BuildInfoApi	buildInfoGetInfo	GET /api/backoffice/v1/info	Returns assembly build info.
BuildInfoApi	buildInfoHeadInfo	HEAD /api/backoffice/v1/info	Returns assembly build info.
ProductReferencesManagementApi	productReferencesManagementCreate	POST /api/backoffice/v1/product-references	Creates a new storefront product reference.
ProductReferencesManagementApi	productReferencesManagementDelete	DELETE /api/backoffice/v1/product-references/{reference}	Deletes the storefront product reference.
ProductReferencesManagementApi	productReferencesManagementGet	GET /api/backoffice/v1/product-references/{reference}	Returns a storefront product reference.
ProductReferencesManagementApi	productReferencesManagementGetAll	GET /api/backoffice/v1/product-references	Returns all storefront product references relevant to the specified query parameters.
ProductsManagementApi	productsManagementCreateDesignsConnections	POST /api/backoffice/v1/products/{id}/design-connections	Creates new designs connections for a specified product.
ProductsManagementApi	productsManagementCreateDocumentsConnections	POST /api/backoffice/v1/products/{id}/document-connections	Creates new documents connections for a specified product.
ProductsManagementApi	productsManagementCreateMockupsConnections	POST /api/backoffice/v1/products/{id}/mockup-connections	Creates new mockups connections for a specified product.
ProductsManagementApi	productsManagementCreateProduct	POST /api/backoffice/v1/products	Creates a new product and returns its description.
ProductsManagementApi	productsManagementDeleteProduct	DELETE /api/backoffice/v1/products/{id}	Deletes a product by its identifier.
ProductsManagementApi	productsManagementGetAllProducts	GET /api/backoffice/v1/products	Returns all products, relevant to the specified query parameters.
ProductsManagementApi	productsManagementGetAvailablePersonalizationWorkflows	GET /api/backoffice/v1/products/available-workflows	Returns all available product personalization workflows.
ProductsManagementApi	productsManagementGetAvailableProcessingPipelines	GET /api/backoffice/v1/products/available-pipelines	Returns all available product processing pipelines.
ProductsManagementApi	productsManagementGetProduct	GET /api/backoffice/v1/products/{id}	Returns a product by its identifier.
ProductsManagementApi	productsManagementGetProductOptions	GET /api/backoffice/v1/products/{id}/options	Returns a list of product options.
ProductsManagementApi	productsManagementGetProductVariant	GET /api/backoffice/v1/products/{id}/variants/{productVariantId}	Returns a product variant.
ProductsManagementApi	productsManagementGetProductVariantDesigns	GET /api/backoffice/v1/products/{id}/variant-designs	Returns a list of product variant designs.
ProductsManagementApi	productsManagementGetProductVariantDocuments	GET /api/backoffice/v1/products/{id}/variant-documents	Returns a list of product variant documents.
ProductsManagementApi	productsManagementGetProductVariantMockups	GET /api/backoffice/v1/products/{id}/variant-mockups	Returns a list of product variant mockups.
ProductsManagementApi	productsManagementGetProductVariants	GET /api/backoffice/v1/products/{id}/variants	Returns a list of product variants.
ProductsManagementApi	productsManagementImportProducts	POST /api/backoffice/v1/products/import	Imports products from a specific CSV file and returns a list of imported products descriptions.
ProductsManagementApi	productsManagementRemoveDesignsConnections	DELETE /api/backoffice/v1/products/{id}/design-connections	Removes designs connections for a specified product.
ProductsManagementApi	productsManagementRemoveDocumentsConnections	DELETE /api/backoffice/v1/products/{id}/document-connections	Removes documents connections for a specified product.
ProductsManagementApi	productsManagementRemoveMockupsConnections	DELETE /api/backoffice/v1/products/{id}/mockup-connections	Removes mockups connections for a specified product.
ProductsManagementApi	productsManagementSetProductVariantAvailability	POST /api/backoffice/v1/products/{id}/set-variant-availability	Set product variants availability. Variants identifiers will be changed.
ProductsManagementApi	productsManagementSetProductVariantPrice	POST /api/backoffice/v1/products/{id}/set-variant-price	Set product variants price. Variants identifiers will be changed.
ProductsManagementApi	productsManagementSetProductVariantSku	POST /api/backoffice/v1/products/{id}/set-variant-sku	Set product variants SKU. Variants identifiers will be changed.
StorefrontsManagementApi	storefrontsManagementCreateBigCommerceStorefront	POST /api/backoffice/v1/storefronts/bigcommerce	Creates new BigCommerce storefront.
StorefrontsManagementApi	storefrontsManagementCreateCustomStorefront	POST /api/backoffice/v1/storefronts/custom	Creates new custom storefront.
StorefrontsManagementApi	storefrontsManagementCreateMagentoStorefront	POST /api/backoffice/v1/storefronts/magento	Creates new Magento storefront.
StorefrontsManagementApi	storefrontsManagementCreateNopCommerceStorefront	POST /api/backoffice/v1/storefronts/nopcommerce	Creates new NopCommerce storefront.
StorefrontsManagementApi	storefrontsManagementCreateWooCommerceStorefront	POST /api/backoffice/v1/storefronts/woocommerce	Creates new WooCommerce storefront.
StorefrontsManagementApi	storefrontsManagementDelete	DELETE /api/backoffice/v1/storefronts/{id}	Deletes an existing storefront by its identifier.
StorefrontsManagementApi	storefrontsManagementGet	GET /api/backoffice/v1/storefronts/{id}	Returns a storefront by identifier.
StorefrontsManagementApi	storefrontsManagementGetAll	GET /api/backoffice/v1/storefronts	Returns all storefronts, relevant to the specified query parameters.
StorefrontsManagementApi	storefrontsManagementGetBigCommerceStorefront	GET /api/backoffice/v1/storefronts/bigcommerce/{id}	Returns extended information about BigCommerce storefront.
StorefrontsManagementApi	storefrontsManagementGetCustomStorefront	GET /api/backoffice/v1/storefronts/custom/{id}	Returns extended information about custom storefront.
StorefrontsManagementApi	storefrontsManagementGetMagentoStorefront	GET /api/backoffice/v1/storefronts/magento/{id}	Returns extended information about Magento storefront.
StorefrontsManagementApi	storefrontsManagementGetNopCommerceStorefront	GET /api/backoffice/v1/storefronts/nopcommerce/{id}	Returns extended information about NopCommerce storefront.
StorefrontsManagementApi	storefrontsManagementGetWooCommerceStorefront	GET /api/backoffice/v1/storefronts/woocommerce/{id}	Returns extended information about WooCommerce storefront.
UsersManagementApi	usersManagementCreate	POST /api/backoffice/v1/users	Creates a new tenant user.
UsersManagementApi	usersManagementDelete	DELETE /api/backoffice/v1/users/{id}	Deletes an existing tenant user.
UsersManagementApi	usersManagementGet	GET /api/backoffice/v1/users/{id}	Returns a tenant user by user identifier.
UsersManagementApi	usersManagementGetAll	GET /api/backoffice/v1/users	Returns a tenant users list.
UsersManagementApi	usersManagementGetAllRoles	GET /api/backoffice/v1/users/roles	Returns all tenant user roles, relevant to the specified query parameters.

Models

• AppearanceDataDto
• AppearanceDataItemDto
• AppearanceDataType
• BigCommerceSettingsDto
• BigCommerceStorefrontDto
• BuildInfoModel
• ConflictType
• CreateBigCommerceStorefrontDto
• CreateCustomStorefrontDto
• CreateMagentoStorefrontDto
• CreateNopCommerceStorefrontDto
• CreateProductDesignConnectionsDto
• CreateProductDocumentConnectionsDto
• CreateProductDto
• CreateProductMockupConnectionsDto
• CreateProductOptionDto
• CreateProductOptionValueDto
• CreateProductReferenceDto
• CreateTenantUserDto
• CreateWooCommerceStorefrontDto
• CustomStorefrontDto
• GeneralConflictDto
• ImageInfo
• MagentoSettingsDto
• MagentoStorefrontDto
• MicrosoftAspNetCoreMvcProblemDetails
• NopCommerceSettingsDto
• NopCommerceStorefrontDto
• OptionType
• PagedOfPersonalizationWorkflowDto
• PagedOfProcessingPipelineDto
• PagedOfProductDto
• PagedOfProductOptionDto
• PagedOfProductReferenceDto
• PagedOfProductVariantDesignDto
• PagedOfProductVariantDocumentDto
• PagedOfProductVariantDto
• PagedOfProductVariantMockupDto
• PagedOfStorefrontDto
• PagedOfTenantUserDto
• PagedOfTenantUserRoleDto
• PersonalizationWorkflowDto
• ProcessingPipelineDto
• ProductAssetConnectionOptionsDto
• ProductDesignConnectionDto
• ProductDocumentConnectionDto
• ProductDto
• ProductMockupConnectionDto
• ProductMockupType
• ProductOptionDto
• ProductOptionValueDto
• ProductReferenceCreationConflictDto
• ProductReferenceDto
• ProductReferenceInfo
• ProductReferenceType
• ProductVariantAvailabilityDto
• ProductVariantDesignDto
• ProductVariantDocumentDto
• ProductVariantDto
• ProductVariantMockupDto
• ProductVariantMockupType
• ProductVariantOptionDto
• ProductVariantPriceDto
• ProductVariantResourceDto
• ProductVariantResourcePreview
• ProductVariantResourceType
• ProductVariantSkuDto
• RemoveProductAssetConnectionDto
• RemoveProductDesignConnectionsDto
• RemoveProductDocumentConnectionsDto
• RemoveProductMockupConnectionsDto
• SetProductVariantAvailabilityDto
• SetProductVariantPriceDto
• SetProductVariantSkuDto
• SimpleOptionValue
• StorefrontDto
• StorefrontType
• SurfaceUsageType
• TenantUserDto
• TenantUserRoleDto
• WooCommerceSettingsDto
• WooCommerceStorefrontDto
• WorkflowType

Authorization

Authentication schemes defined for the API:

ApiKey

• Type: API key
• API key parameter name: X-API-Key
• Location: HTTP header

Bearer

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

OAuth2ClientCredentials

• Type: OAuth
• Flow: application
• Authorization URL: ``
• Scopes: N/A

OAuth2Implicit

• Type: OAuth
• Flow: implicit
• Authorization URL: https://localhost:44378/connect/authorize
• Scopes:
  • Projects_full: Manipulate projects
  • Projects_read: Read projects
  • Templates_full: Manipulate products
  • Templates_read: Read products
  • Storefronts_full: Manipulate products
  • Storefronts_read: Read products
  • StorefrontUsers_full: Manipulate storefront users
  • StorefrontUsers_read: Read storefront users
  • TenantUsers_full: Manipulate storefront users
  • TenantUsers_read: Read storefront users

oauth2-code

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://localhost:44378/connect/authorize
• Scopes:
  • Projects_full: Manipulate projects
  • Projects_read: Read projects
  • Templates_full: Manipulate products
  • Templates_read: Read products
  • Storefronts_full: Manipulate products
  • Storefronts_read: Read products
  • StorefrontUsers_full: Manipulate storefront users
  • StorefrontUsers_read: Read storefront users
  • TenantUsers_full: Manipulate storefront users
  • TenantUsers_read: Read storefront users