shopgate/connect-integration-sdk-php

支持与 Shopgate Connect 平台集成的 PHP 框架。


README

Build Status Coverage Status License GitHub (pre-)release

Shopgate Connect 集成 SDK 是一组用于管理您的商店系统和 Shopgate Connect 之间通信的类。

https://developer.shopgate.com 创建开发者账号

需求

  • PHP 5.6 及以上

安装

composer require shopgate/connect-integration-sdk-php

或从 发布页面 下载并解压。

迁移到 2.x

如果您是从 1.x 升级到 2.x,请阅读 迁移指南

快速开始

订单创建示例(完整请求规范请见 订单 API 文档

<?php
use Shopgate\ConnectSdk\ShopgateSdk;

$order = [
    'localeCode' => 'de-de',
    'currencyCode' => 'EUR',
    'addressSequences' => [...],
    'primaryBillToAddressSequenceIndex' => 0,
    'lineItems' => [...],
    'subTotal' => 109.99,
    'total' => 115.89,
    'submitDate' => '2019-09-02T09:02:57.733Z',
    'imported' => true
];

$config = [
    'merchantCode'  => 'MERCHANT_CODE',
    'clientId'      => 'my-client',
    'clientSecret'  => '*******',
    'username'      => 'my.address@my-domain.com',
    'password'      => '*******',
    'env'           => 'pg' // Optional. "dev", "pg" or empty (= production)
];

$sgSdk = new ShopgateSdk($config);

try {
    $response = $sgSdk->getOrderService()->addOrders([$order]);
    var_dump($resonse);
} catch (\Exception $e) {
    var_dump($e);
}

配置参数

  • clientId(字符串)- oAuth2 客户端 ID
  • clientSecret(字符串)- oAuth2 客户端密钥
  • merchantCode(字符串)- 注册时提供的商户代码
  • username -(字符串)- Shopgate Next Admin 中名为 "Api Credentials" 的用户的电子邮件地址
  • password -(字符串)- Shopgate Next Admin 中名为 "Api Credentials" 的用户的密码
  • env(字符串,默认:production)- "dev"、"staging"、"production" 之一

变更日志

更多信息请见 CHANGELOG.md 文件。

贡献

更多信息请见 CONTRIBUTING.md 文件。

关于 Shopgate

Shopgate 是领先的移动电子商务平台。

许可

Shopgate Connect 集成 SDK 在 Apache License,Version 2.0 许可下提供。

更多信息请见 LICENSE.md 文件。

高级

"baseUri" 配置

对于针对 echo 服务进行测试,可以覆盖 baseUri 配置。默认为 https://{service}.shopgate{env}.io/{version}/merchants/{merchantCode}/,支持模板变量

  • service - 请求的服务名称,每个请求不同
  • env - Shopgate 环境相关的域名后缀;这将自动替换为 "dev"、"pg"(预发布)或 ""(生产)之一
  • version - API 版本,每个请求可能不同
  • merchantCode - 配置中设置的商户代码