vendloop/ vendloop-php

用于与 Vendloop REST API 通信的 PHP 库。

v1.1.0 2024-07-18 15:05 UTC

This package is auto-updated.

Last update: 2024-09-23 19:48:44 UTC


README

Vendloop PHP 库提供了方便的应用程序访问 Vendloop API 的途径。它包括一组预定义的类,这些类可以从 API 响应中动态初始化,使其与多种版本的 Vendloop API 兼容。

要求

PHP 5.6.0 及更高版本。

安装

Composer

您可以通过 Composer 安装这些绑定。运行以下命令

composer require vendloop/vendloop-php

使用绑定时,请使用 Composer 的 自动加载

require_once 'vendor/autoload.php';

手动安装

如果您不想使用 Composer,您可以下载最新的版本 。然后,要使用绑定,请包含 autoload.php 文件。

require_once '/path/to/vendloop-php/src/autoload.php';

依赖项

为了正确工作,这些绑定需要以下扩展

  • curl,尽管如果您愿意,也可以使用自己的非 cURL 客户端
  • json
  • mbstring(多字节字符串)

如果您使用 Composer,这些依赖项应该会自动处理。如果您手动安装,请确保这些扩展可用。

入门

简单用法如下

use Vendloop\VendloopClient;

$vendloop = new \Vendloop\VendloopClient('sk_live_aa873dabc21fba4d45762bf0b18b56d79a18e37b');
try {
    $customer = $vendloop->customers->fetch([
        'id' => 12
    ]);
    echo $customer;
} catch(\Vendloop\Exception\ApiException $e){
    die($e->getMessage());
}

VendloopClient 类也接受一个配置值数组

$vendloop = new \Vendloop\VendloopClient([
    'api_key' => 'sk_live_aa873dabc21fba4d45f0b18b56d79a18e37762bb', // your api key
    'base_url' => 'https://api.vendloop.com', // to change the endpoint URL to a mock server
    'use_guzzle' => false // if true, use guzzle for API calls (guzzle should be installed)
]);

查看 SAMPLES 以获取更多 API 用法的示例

文档

请参阅 API 文档 获取详细信息。

SSL / TLS 兼容性问题

确认您的服务器可以与 Vendloop 服务器的 TLSv1.2 连接。大多数最新的软件都有这个功能。如果您遇到任何 SSL 错误,请联系您的服务提供商以获取指导。不要禁用 SSL 互验!

建议的操作是升级您的 cURL 和 OpenSSL 包,以便默认使用 TLS 1.2。

支持

新功能和错误修复都会发布在最新主要版本的 Vendloop PHP 库上。如果您使用的是旧版本,我们建议您升级到最新版本,以便使用新功能和错误修复,包括安全漏洞修复。该软件包的旧主要版本将继续可用,但不会收到任何更新。

更新日志

请参阅 更新日志 了解最近更改的详细信息。

贡献

请参阅 贡献指南行为准则 获取详细信息。查看我们的 TODO 了解已经计划的功能。

安全性

如果您发现任何与安全相关的问题,请通过电子邮件发送至 geoorg30@gmail.com,而不是使用问题追踪器。

许可证

MIT许可证(MIT)。有关更多信息,请参阅许可证文件