cdiscount / sdkphpapi
Cdiscount Marketplace API 的 PHP SDK
Requires
This package is not auto-updated.
Last update: 2024-09-27 10:20:08 UTC
README
1.1 - 最小要求
- Apache 2.2
- Php 5.6
2.1- 在您的根项目文件夹中克隆 Git 仓库
SDK 结构如下
- config/ : 配置文件
- samples/ : 样本文件夹
- sdk/ : Cdiscount SDK 的内容(不要修改此文件夹中的任何文件)
2.2- 在 SDK 文件夹的根路径下运行 'composer update' 命令以下载 Zend Framework 依赖项
3 - 插入您的 API 凭据
3.1 - 要求
要使用 Cdiscount Marketplace API 和 Cdiscount Marketplace SDK,您首先需要遵循 Cdiscount Marketplace API 网站上描述的步骤。
章节如下
- 请求创建账户。
- 已设置您的账户
3.2 - 更新配置文件
按照插入 API 凭据的流程进行操作
- 打开配置文件夹
- 打开 config.ini 文件
- 设置 api 模式:'preprod' 或 'prod'
- 打开 preprod.config.ini 文件或 prod.config.ini 文件(如果将模式设置为 'prod')
- 设置您的 api 用户名
- 设置您的 api 密码
4 - 使用 SDK
4.1 - 使用端点
SDK 包含以下端点
- 卖家
- 商品
- 讨论
- 产品
- 订单
- 中继
所有 SDK 方法都在 MarketPlace API 网站上进行了描述,因为它们的名称与 Cdiscount Marketplace API 方法相同。
对于每个方法,您都有一个包含调用相应 API 函数的示例的 PHP 文件。
例如,要调用 GetSellerInformation API 方法,打开位于 Seller 文件夹中的 GetSellerInformation.php 文件,并按照示例的步骤进行操作。
4.2 - CDSApiClient 对象
CDSApiClient 允许您调用 API。
CDSApiClient 对象包含所有端点。它还会为您创建一个获取令牌的 API 调用。
不要每次调用 API 时都创建新的 CDSApiClient !
您可以使用(必须)相同的 CDSApiClient 对所有 API 调用。
以下是一个使用相同的 CDSApiClient 进行许多 API 调用的示例
$client = new \Sdk\ApiClient\CDSApiClient(); $token = $client->init(); if ($token == null || !$client->isTokenValid()) { echo "生成令牌时出现问题"; die; } $offerPoint = $client->getOfferPoint(); $offerListResponse = $offerPoint->getOfferList(null); /** 在此处解析 $offerListResponse **/ $sellerPoint = $client->getSellerPoint(); $sellerResponse = $sellerPoint->getSellerInformation(); /** 在此处解析 $sellerResponse **/
5 - 更新 SDK
从 CDiscount Marketplace API 网站下载新的 SDK Zip 文件
使用新的 SDK 替换 SDK 文件夹
使用新的替换 vendor 文件夹
注意
在示例中,错误报告参数错误错误错误报告设置为 '-1'。在生产模式下不要保留它。