lifefile-llc/authorize-net-sdk-php

Authorize.Net的官方PHP SDK

2.0.3 2021-07-13 22:17 UTC

README

Travis CI Status Scrutinizer Code Quality Packagist Stable Version

需求

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

从旧版本迁移

自2018年8月起,Authorize.Net API已重新组织,以更加关注商家。已弃用Authorize.Net AIM、ARB、CIM、交易报告和SIM类,以支持net\authorize\api。要查看新功能与已弃用功能的完整映射列表,请参阅MIGRATING.md

贡献

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

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。(注意:我们从不建议您覆盖新的安全http默认设置)。按照以下示例更新您的composer.json文件,然后运行composer update来更新此特定版本。

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

通过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)或屏蔽(例如,显示信用卡号的最后4位)的XML标签。
    • patternreplacement 可以留空 "",如果默认值(在 Log.php 中定义)将被使用。pattern 提供识别正则表达式,而 replacement 定义可见部分。
    • disableMask 可以设置为 true,以允许日志完全显示对象中的属性或XML字符串中的标签。
  • sensitiveStringRegexes 包含信用卡正则表达式的列表。因此,如果信用卡号尚未被屏蔽,它将被完全屏蔽。
  • 定义正则表达式时,请注意非ASCII字符(参考 手册)。例如,使用 "pattern": "(\\p{N}+)(\\p{N}{4})" 而不是 "pattern": "(\\d+)(\\d{4})"。同时注意使用了 \\ 转义序列。

: 对于任何正则表达式,不应定义起始或结束的 '/' 或任何其他分隔符。代码中添加了 '/' 分隔符和Unicode标志。

交易哈希升级

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

许可证

此存储库在专有许可证下分发。请参阅提供的 LICENSE.txt 文件。