mobi-market/cdiscount-sdkphpapi

Cdiscount Marketplace API 的 PHP SDK

v2.1.0 2022-01-06 10:19 UTC

README

此软件包已更新为使用 laminas 框架(替代 zend)以及 PHP 7.4 或 PHP 8.0 的最低要求,以便在更现代的代码中使用。

此软件包是对 Cdiscount/API-MarketPlace-SDK-PHP 父级软件包的更新。

主要变更包括能够在不修改提供的 config.ini 文件的情况下,将用户名、密码、token URL 和 cURL 选项传递到 API 功能中。

进行这些更改的原因是为了更好地支持 Laravel 等框架,并劝阻用户直接编辑 vendor 目录中的文件。

安装

1- 安装一个 Web 服务器(例如 Windows 的 wamp)

1.1 - 最小要求

2- 安装软件包

使用 composer 或通过克隆。

2.1a - 使用 composer 添加到项目中

composer require mobi-market/cdiscount-sdkphpapi

2.1b - 在项目根目录中克隆 Git 仓库

SDK 结构如下

  • config/ : 配置文件
  • samples/ : 样例文件夹
  • sdk/ : Cdiscount SDK 内容(不要修改此文件夹中的任何文件)

2.2b - 在 SDK 文件夹的根目录中运行 'composer update' 命令以下载 Laminas 框架依赖项

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 对象包含所有端点。它还会为您创建一个获取 token 的 API 调用。

不要每次调用 API 时都创建一个新的 CDSApiClient!

您可以(必须)为所有的API调用使用相同的CDSApiClient。

以下是如何为多个API调用使用相同的CDSApiClient的示例

$client = new \Sdk\ApiClient\CDSApiClient();
$token = $client->init();
if ($token == null || !$client->isTokenValid()) {
	echo "Souci lors de la génération du token";
	die;
}
$offerPoint = $client->getOfferPoint();
$offerListResponse = $offerPoint->getOfferList(null); /** Parse here $offerListResponse **/
$sellerPoint = $client->getSellerPoint();
$sellerResponse = $sellerPoint->getSellerInformation(); /** Parse here $sellerResponse **/

5 - 更新SDK

从CDiscount Marketplace API网站下载新的SDK Zip文件

删除SDK文件夹,并用新的替换

删除供应商文件夹,并用新的替换

注意

在示例中,参数error_reporting设置为'-1'。请不要在生产模式下使用它。