powersync/authorizenet-sdk-php

Authorize.Net 官方 PHP SDK


README

Travis CI Status Scrutinizer Code Quality Packagist Stable Version

要求

  • PHP 5.6+
  • cURL PHP 扩展
  • JSON PHP 扩展
  • 一个 Authorize.Net 账户(见下文 注册与配置 部分)
  • 支持 TLS 1.2 的 libcurl 和 OpenSSL 版本(或其等效版本)

从旧版本迁移

自 2018 年 8 月以来,Authorize.Net API 已重新组织,以更加关注商户。已弃用 Authorize.Net AIM、ARB、CIM、交易报告和 SIM 类,改用 net\authorize\api。要查看对应于弃用功能的完整新特性列表,请参阅 MIGRATING.md

贡献

  • 如果您需要有关 Authorize.Net 功能的信息或澄清,请创建一个包含您问题的 issue。您还可以搜索 Authorize.Net 开发者社区 中与您问题相关的讨论。
  • 在创建 pull requests 之前,请阅读 贡献指南

TLS 1.2

Authorize.Net API 仅支持使用 TLS 1.2 安全协议进行连接。请确保升级所有必要的组件以支持 TLS 1.2。保持这些组件的最新状态,以减轻新安全漏洞的风险。

要测试您的当前安装是否能够使用 TLS 1.2 与我们的服务器通信,请运行以下 PHP 代码并检查输出中的 TLS 版本

<?php
    $ch = curl_init('https://apitest.authorize.net/xml/v1/request.api');
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_VERBOSE, true);
    $data = curl_exec($ch);
    curl_close($ch);

如果 curl 无法连接到我们的 URL(如前一个示例所示),则您的系统可能无法使用 TLS 1.2 进行连接,或者没有安装受支持的加密算法。要验证您的连接支持哪个 TLS 版本,请运行以下 PHP 代码

<?php 
$ch = curl_init('https://www.howsmyssl.com/a/check');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$data = curl_exec($ch);
curl_close($ch);

$json = json_decode($data);
echo "Connection uses " . $json->tls_version ."\n";

安装

Composer

我们建议使用 Composer(注意:我们从不建议您覆盖新的 secure-http 默认设置)按照以下示例更新您的 composer.json 文件,然后运行 composer update 以更新此特定版本。

{
  "require": {
  "php": ">=5.6",
  "authorizenet/authorizenet": "2.0.1"
  }
}

通过 Composer 进行安装后,不要忘记在您的脚本或引导文件中要求其自动加载器

require 'vendor/autoload.php';

自定义 SPL 自动加载器

或者,我们提供了一个自定义的 SPL 自动加载器,您可以从 PHP 文件中引用

require 'path/to/anet_php_sdk/autoload.php';

此自动加载器仍然需要 vendor 目录及其所有依赖项存在。但是,这是在无法在特定系统上运行 composer 的情况下的可能解决方案。您可以在本地或在另一台系统上运行 composer 来构建目录,然后将 vendor 目录复制到所需的系统。

注册与配置

使用此 SDK 和 Authorize.Net API 需要在 Authorize.Net 系统上拥有账户。您可以在设置部分找到这些详细信息。如果您目前没有生产环境的 Authorize.Net 账户,请注册沙盒账户

身份验证

使用 Authorize.Net API 进行身份验证时,请使用您的账户的 API 登录 ID 和交易密钥。如果您没有这些凭证,请从商家界面获取它们。对于生产账户,商家界面位于 (https://account.authorize.net/),而对于沙盒账户,位于 (https://sandbox.authorize.net)。

获取凭证后,将它们加载到您的代码中适当的变量中。以下示例代码展示了如何将凭证作为 API 请求的一部分进行设置。

为 API 请求设置您的 API 凭证

...

use net\authorize\api\contract\v1 as AnetAPI;

...

$merchantAuthentication = new AnetAPI\MerchantAuthenticationType();
$merchantAuthentication->setName("YOURLOGIN");
$merchantAuthentication->setTransactionKey("YOURKEY");

...

$request = new AnetAPI\CreateTransactionRequest();
$request->setMerchantAuthentication($merchantAuthentication);

...

您绝对不应该将登录 ID 和交易密钥直接包含在您的网站公开可访问部分的 PHP 文件中。更好的做法是将这些定义在常量文件中,然后在代码的适当位置引用这些常量。

在沙盒环境和生产环境之间切换

Authorize.Net 维护一个完整的沙盒环境用于测试和开发。沙盒环境是生产环境的精确复制品,包括模拟的交易授权和结算。默认情况下,此 SDK 配置为使用沙盒环境。要切换到生产环境,请替换执行方法中的环境常量。例如

// For PRODUCTION use
$response = $controller->executeWithApiResponse(\net\authorize\api\constants\ANetEnvironment::PRODUCTION);

每个环境的 API 凭证都不同,因此切换环境时,请确保切换到适当的凭证。

SDK 使用示例和示例代码

要开始使用此 SDK,强烈建议下载我们的示例代码库

在该存储库中,我们提供了我们 API 所有常见用途的全面示例代码

此外,您可以在我们的 API 参考指南中找到我们 API 结构的详细信息和示例

API 参考指南提供了特定请求所需信息以及这些信息如何格式化的示例。使用这些示例,您可以使用此 SDK 确定包含该信息所需的必要方法。

构建和测试 SDK

AuthorizeNet SDK 的集成测试位于 tests 目录中。这些测试主要用于 SDK 开发。但是,您也可以浏览它们以找到各种 API 的更多使用示例。

  • 运行 composer update --dev 以加载 PHPUnit 测试库。
  • phpunit.xml.dist 文件复制到 phpunit.xml 并在常量字段中输入您的商家凭证。
  • 运行 vendor/bin/phpunit 以运行测试套件。

您可能希望禁用沙盒账户中的电子邮件。

测试指南

为了在测试您自己的代码时获得更多帮助,Authorize.Net 维护了一个 全面的测试指南,其中包括用于测试的信用卡卡号和用于从沙盒环境生成特定响应的特殊触发器。

日志记录

SDK 生成带有对敏感数据(如信用卡、到期日期)进行屏蔽的日志。提供的日志级别为 debuginfowarnerror。添加 use \net\authorize\util\LogFactory;。可以使用 $logger = LogFactory::getLog(get_class($this)); 初始化记录器。默认日志文件 phplog 在当前文件夹中生成。后续日志追加到同一文件,除非执行文件夹更改,此时将生成新的日志文件。

使用示例

  • 记录字符串消息 $logger->debug("发送 'XML' 请求类型");
  • 记录 xml 字符串 $logger->debug($xmlRequest);
  • 使用格式化进行日志记录 $logger->debugFormat("整数: %d, 浮点数: %f, XML请求: %s\n", array(100, 1.29f, $xmlRequest));

自定义敏感标签

当首次执行调用日志器的代码时,会生成一个AuthorizedNetSensitiveTagsConfig.json的本地副本。开发人员可以稍后编辑该本地文件以重新配置哪些内容被隐藏,哪些内容可见。(请勿编辑SDK中的JSON文件)。

  • 对于sensitiveTags数组中的每个元素,
    • tagName字段对应对象中的属性名称或应完全隐藏(如果没有指定替换,则显示XXXX)或被屏蔽的xml标签(例如,显示信用卡号码的最后四位)。
    • pattern[注意]replacement[注意]可以留为"",如果使用默认值(如在Log.php中定义)。pattern提供用于识别的regex,而replacement定义可见部分。
    • disableMask可以设置为true,以便允许日志完全显示对象中的属性或XML字符串中的标签。
  • sensitiveStringRegexes[注意]包含信用卡regex列表。因此,如果信用卡号尚未被屏蔽,它将被完全屏蔽。
  • 在定义regex时要留意非ASCII字符(参考手册),例如,使用"pattern": "(\\p{N}+)(\\p{N}{4})"代替"pattern": "(\\d+)(\\d{4})"。另外,请注意使用了\\转义序列。

注意: 对于任何regex,不应定义起始或结束的'/'或任何其他分隔符。在代码中添加了'/'分隔符和unicode标志。

交易哈希升级

Authorize.Net正在逐步淘汰基于MD5的transHash元素,转而使用基于SHA-512的transHashSHA2。控制MD5哈希选项的商户接口设置不再可用,并且transHash元素将在未来某个日期停止返回值。有关如何使用transHashSHA2的信息,请参阅[交易哈希升级指南](https://developer.authorize.net/support/hash_upgrade/)。

许可协议

本存储库采用专有许可协议分发。请参阅提供的LICENSE.txt文件。