aurigma/php-storefront-products-client

PHP API 客户端，用于Customer's Canvas网络印刷系统中的Storefront Products API服务。

维护者

详细信息

github.com/aurigma/php-storefront-products-client

主页

源代码

问题

安装: 34

依赖关系: 0

建议者: 0

安全: 0

星标: 0

关注者: 4

分支: 0

公开问题: 0

2.0.1 2024-07-30 09:19 UTC

Requires

Requires (Dev)

proprietary e44744c0543cf0a85c5bf56c9ea463c4e8bb71b9

productsapi clientweb-to-printstorefrontcustomers canvas

This package is auto-updated.

Last update: 2024-09-30 09:39:29 UTC

README

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

本模块是Storefront Products API服务的PHP API客户端，该服务是Customer's Canvas网络印刷系统的一部分。假设您熟悉其服务并了解如何使用其API。要了解更多关于Customer's Canvas及其服务的信息，请参阅其文档中的入门部分。

先决条件

要使用此包，您需要满足以下要求

  • 您必须在Customer's Canvas上有一个账户。

有关其他平台，请参阅Customer's Canvas文档中的后端服务文章。

安装

composer require aurigma/php-storefront-products-client

要求

PHP 7.2 及以上版本。

Composer

要通过Composer安装绑定，请将以下内容添加到 composer.json

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

然后运行 composer install

手动安装

下载文件并包含 autoload.php

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

入门

请按照安装过程进行操作，然后运行以下命令

<?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;
}

测试

要运行测试，请使用

composer install
vendor/bin/phpunit

作者

Aurigma Inc info@aurigma.com (https://customerscanvas.com)

API 端点

所有URI都是相对于https://

模型