包简介

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

README 文档

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 info@aurigma.com (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

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

aurigma/php-backoffice-client 适用场景与选型建议

aurigma/php-backoffice-client 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 6 次下载、GitHub Stars 达 0，最近一次更新时间为 2025 年 08 月 07 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「backoffice」「api client」「web-to-print」「customers canvas」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 aurigma/php-backoffice-client 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 aurigma/php-backoffice-client 我们能提供哪些服务？

定制开发 / 二次开发

基于 aurigma/php-backoffice-client 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

与 aurigma/php-backoffice-client 相关的其它包

同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：

roadiz/documents 0

Roadiz sub-package for Document system.

roadiz/models 0

Roadiz base models for entities.

roadiz/roadiz 372

Roadiz is a modern CMS based on a polymorphic content-schema system which can handle many types of services. It’s based on Symfony component and Doctrine ORM for maximum performances and security.

roadiz/rozier 0

Roadiz CMS backoffice theme

roadiz/compat-bundle 0

theodorejb/phaster 6

A PSR-7 compatible library for making CRUD API endpoints

aurigma/php-backoffice-client

包简介

关键字：