payever/core-sdk-php

payever的核心PHP SDK

2.1.0 2024-07-16 06:23 UTC

This package is auto-updated.

Last update: 2024-09-16 06:51:29 UTC


README

Scrutinizer Code Quality Build Status Code Intelligence Status Latest Stable Version Total Downloads License

本存储库包含一个开源PHP SDK,允许您从PHP应用程序访问payever。

注意:此库遵循语义版本规范。有关更多信息,请参阅semver.org

请注意:此SDK用于payever插件中。它不适用于自定义API集成。如果您想通过API与我们集成,请访问https://docs.payever.org/shopsystems/api,并遵循提供的说明和代码示例。

故障排除

如果您遇到问题,可以通过官方支持渠道联系我们 - support@getpayever.com

要求

安装

您可以使用 Composer

首选方法是使用 composer。如果您尚未安装composer,请遵循安装说明

安装composer后,在您的项目根目录中执行以下命令以安装此库

composer require payever/core-sdk-php

文档

原始HTTP API文档可在此处找到 - https://docs.payever.org/shopsystems/api

枚举

API内部使用了多个固定字符串值的列表。为了方便,它们被表示为常量并分组到类中。

  • 核心

API客户端

与payever的HTTP API通信通过API客户端进行。根据API类别有不同的几个客户端

以下将详细介绍每个客户端。

配置

每个API客户端都需要将配置对象作为客户端构造函数的第一个参数。要获取有效的配置对象,您需要有效的API凭据。

  • 客户端ID
  • 客户端密钥
  • 业务UUID

此外,您还需要告诉您正在使用哪个API通道

use Payever\Sdk\Core\ClientConfiguration;
use Payever\Sdk\Core\Enum\ChannelSet;

$clientId = 'your-oauth2-client-id';
$clientSecret = 'your-oauth2-client-secret';
$businessUuid = '88888888-4444-4444-4444-121212121212';

$clientConfiguration = new ClientConfiguration();

$clientConfiguration
    ->setClientId($clientId)
    ->setClientSecret($clientSecret)
    ->setBusinessUuid($businessUuid)
    ->setChannelSet(ChannelSet::CHANNEL_MAGENTO)
    ->setApiMode(ClientConfiguration::API_MODE_LIVE)
;

注意:以下所有示例都假设您在$clientConfiguration变量中实例化了ClientConfiguration

日志记录

您可以通过提供PSR-3兼容的日志记录器实例来设置所有API交互的日志记录。

如果您没有PSR-3兼容的日志记录器,此SDK包含一个简单的文件日志记录器。

use Psr\Log\LogLevel;
use Payever\Sdk\Core\Logger\FileLogger;

$logger = new FileLogger(__DIR__.'/payever.log', LogLevel::INFO);
$clientConfiguration->setLogger($logger);

许可证

有关更多信息,请参阅许可证文件