README

如何构建

生成的代码对外部库（如UniRest）有依赖。这些依赖在SDK中包含的 composer.json 文件中定义。为了解决这些依赖，我们使用Composer包管理器，它需要系统上安装PHP版本大于5.3.2。访问 https://composer.php.ac.cn/download/ 下载Composer安装文件，并在您的系统中运行它。打开命令提示符并输入 composer --version。如果安装成功，它应该会显示已安装的Composer的当前版本。

• 使用命令行，导航到包含生成的文件（包括 composer.json）的SDK目录。
• 运行命令 composer install。这应该会安装所有必需的依赖，并在您的项目目录中创建 vendor 目录。

[仅限Windows用户] 在php.ini中配置CURL证书路径

CURL曾经包含一组接受的CA列表，但不再捆绑任何CA证书。因此，默认情况下，它将拒绝所有SSL证书，因为无法验证。您必须获取您的CA证书，并将curl指向它。步骤如下

1. 从 https://curl.haxx.se/docs/caextract.html 下载证书束（.pem文件）到您的系统。
2. 将 curl.cainfo = "PATH_TO/cacert.pem" 添加到您的php.ini文件中，该文件位于您的PHP安装中。“PATH_TO”必须是一个包含.pem文件的绝对路径。

[curl]
; A default value for the CURLOPT_CAINFO option. This is required to be an
; absolute path.
;curl.cainfo =

如何使用

以下部分解释了如何在新的项目中使用SGIAvender库。

1. 在IDE中打开项目

打开PHP的IDE，如PhpStorm。这里展示的基本工作流程也适用于您更喜欢使用不同编辑器或IDE的情况。

在PhpStorm中，点击 打开，浏览到生成的SDK目录，然后点击 确定。

2. 添加一个新的测试项目

如下所示，在解决方案名称上右键单击以创建一个新目录

将目录命名为 "test"

向此项目添加一个PHP文件

命名为 "testSDK"

根据您的项目设置，您可能需要在PHP代码中包含Composer的自动加载器，以启用类的自动加载。

require_once "../vendor/autoload.php";

重要的是，require_once中的路径必须正确指向在依赖安装期间创建的vendor目录中的autoload.php文件。

之后，您可以添加代码来初始化客户端库并获取控制器类的实例。后续部分给出了初始化客户端库和使用控制器方法的示例代码。

3. 运行测试项目

要运行您的项目，您必须设置项目的解释器。解释器是安装在您计算机上的PHP引擎。

从 文件 菜单中打开 设置。

在 语言 & 框架 内选择 PHP。

在解释器选项附近浏览解释器，并选择您的解释器。

选择解释器后，点击 确定。

要运行您的项目，在测试项目中的PHP文件上右键单击，然后单击 运行。

如何测试

此SDK中的单元测试可以使用PHPUnit运行。

1. 首先使用composer安装依赖项，包括 require-dev 依赖项。
2. 从命令行运行vendor\bin\phpunit --verbose来执行测试。如果您已全局安装PHPUnit，则使用phpunit --verbose运行测试。

您可以在phpunit.xml文件中更改PHPUnit测试配置。

初始化

API客户端可以按以下方式初始化。

$client = new SGIAvenderLib\SGIAvenderClient();

类参考

控制器列表

• MiscController

MiscController

获取单例实例

可以从API客户端访问MiscController类的单例实例。

$misc = $client->getMisc();

divisiones

TODO: 添加方法描述

function divisiones($body)

参数

示例用法

$bodyValue = "{\r\n  \"idIntegracion\": 21,\r\n  \"token\": \"6be7212a-a769-40e4-9c6b-283aa06a3127\",\r\n  \"idOrigen\": 83\r\n}";
$body = APIHelper::deserialize($bodyValue);

$misc->divisiones($body);

marcas

TODO: 添加方法描述

function marcas($body)

参数

示例用法

$bodyValue = "{\r\n  \"idIntegracion\": 21,\r\n  \"token\": \"6be7212a-a769-40e4-9c6b-283aa06a3127\",\r\n  \"idOrigen\": 83\r\n}";
$body = APIHelper::deserialize($bodyValue);

$misc->marcas($body);

modelos

TODO: 添加方法描述

function modelos($body)

参数

示例用法

$bodyValue = "{\r\n  \"idIntegracion\": 21,\r\n  \"token\": \"6be7212a-a769-40e4-9c6b-283aa06a3127\",\r\n  \"idOrigen\": 83\r\n}";
$body = APIHelper::deserialize($bodyValue);

$misc->modelos($body);

regiones

TODO: 添加方法描述

function regiones($body)

参数

示例用法

$bodyValue = "{\r\n  \"idIntegracion\": 21,\r\n  \"token\": \"6be7212a-a769-40e4-9c6b-283aa06a3127\",\r\n  \"idOrigen\": 83\r\n}";
$body = APIHelper::deserialize($bodyValue);

$misc->regiones($body);

comunas

TODO: 添加方法描述

function comunas($body)

参数

示例用法

$bodyValue = "{\r\n  \"idIntegracion\": 21,\r\n  \"token\": \"6be7212a-a769-40e4-9c6b-283aa06a3127\",\r\n  \"idOrigen\": 83\r\n}";
$body = APIHelper::deserialize($bodyValue);

$misc->comunas($body);

sucursales

TODO: 添加方法描述

function sucursales($body)

参数

示例用法

$bodyValue = "{\r\n  \"idIntegracion\": 21,\r\n  \"token\": \"6be7212a-a769-40e4-9c6b-283aa06a3127\",\r\n  \"idOrigen\": 83\r\n}";
$body = APIHelper::deserialize($bodyValue);

$misc->sucursales($body);

crearProspecto

TODO: 添加方法描述

function crearProspecto($body)

参数

示例用法

$bodyValue = "{\r\n  \"token\": \"6be7212a-a769-40e4-9c6b-283aa06a3127\",\r\n  \"idIntegracion\": 21,\r\n  \"idOrigen\": 83,\r\n  \"idMarca\": 6,\r\n  \"idModelo\": 133,\r\n  \"idSucursal\": 24,\r\n  \"idDivision\": 3,\r\n  \"nombre\": \"David Martinez\",\r\n  \"email\": \"david.martinez@amotorchile.cl\",\r\n  \"fono\": \"951253162\",\r\n  \"comentario\": \"test de integracion desde Avender\"\r\n}";
$body = APIHelper::deserialize($bodyValue);

$misc->crearProspecto($body);

返回控制器列表