omise / omise-php
一个专门用于连接Omise API的PHP库。
Requires
- php: >=5.6
Requires (Dev)
- friendsofphp/php-cs-fixer: ^2.19.3 || ^3.9.5
- phpstan/phpstan: 1.2
- phpunit/phpunit: ^5.7 || ^9.5
- dev-master
- 3.0.x-dev
- v2.18.0
- v2.17.0
- v2.16.1
- v2.16.0
- v2.15.0
- v2.14.0
- v2.14.0-alpha
- v2.13.0
- v2.12.0
- v2.11.2
- v2.11.1
- v2.11.0
- v2.10.0
- v2.9.1
- v2.9.0
- v2.8.0
- v2.7.1
- v2.7.0
- v2.6.0
- v2.5.0
- v2.4.1
- v2.4.0
- v2.3.2
- v2.3.1
- v2.3.0
- v2.2.0
- v2.1.3
- v2.1.2
- dev-bug/keys-in-singleton
- dev-fix_2.12.0_version
- dev-nicodemuz-patch-2
- dev-test-pr
- dev-feature/ENGA3-357-code-coverage
- dev-feature/support_lower_php
- dev-feature/FRON-1506
- dev-feature/add-env-variable
This package is auto-updated.
Last update: 2024-08-26 07:30:35 UTC
README
omise-php
是一个专门设计用于连接 Opn Payments API 的 PHP 库。
安全警告
请勿使用小于 2.12.0 版本的 Omise PHP 库,因为它们已过时且存在安全漏洞。
需求
- PHP v7.4 及以上版本。
- 内置 libcurl 支持。
注意:由于 PHP 生命周期结束,我们鼓励您在 PHP 7.4 或更高版本上运行 Omise-PHP 库,因为低于 7.4 的任何 PHP 版本都没有安全支持。缺乏支持可能会导致安全漏洞。
安装
使用 Composer
您可以通过 Composer 安装此库。如果您尚未安装 Composer,请根据您的操作系统选择以下说明之一进行安装
-
Composer 安装后,您可以在项目目录的根目录中创建一个
composer.json
文件,以将 Omise-PHP 声明为项目依赖项,内容如下{ "require": { "omise/omise-php": "dev-master" } }
-
运行以下命令安装 Omise-PHP 库
php composer.phar install
-
运行
composer install
命令后,Composer 将在composer.json
相同的目录中生成一个vendor
文件夹。在 PHP 脚本中添加以下行以加载库
require_once dirname(__FILE__).'/vendor/autoload.php';
手动
如果您不使用 Composer,可以下载 Omise-PHP 的最新版本。然后,按照说明将 Omise-PHP 安装到项目中。
-
将库提取到您的项目中。
-
在您的 PHP 文件中包含以下行
require_once 'path-to-library/omise-php/lib/Omise.php';
建议使用 Composer,因为您可以轻松地保持库的更新。
配置
• 配置您的公开和密钥
在您第一次向 Opn Payments API 发送请求之前,您需要配置您的 公开密钥 和 密钥(这些可以在 Opn Payments Dashboard 上找到。登录后,从侧边栏菜单转到 密钥)。
将以下代码放置在 Omise-PHP 库加载行的旁边。
define('OMISE_PUBLIC_KEY', 'pkey_test_***'); define('OMISE_SECRET_KEY', 'skey_test_***');
参考: API 身份验证。
ー
• API 版本
为了强制应用程序使用特定的 API 版本,请定义 OMISE_API_VERSION
。
此设置指定的版本将覆盖账户中的版本设置。如果您有多个环境且 API 版本不同(例如,开发使用最新版本,而生产使用旧版本),则此设置非常有用。
define('OMISE_API_VERSION', '2017-11-02');
API版本可以在Opn Payments仪表板中找到。登录后,从右上角菜单选择API版本。
强烈建议将
OMISE_API_VERSION
设置为当前使用的版本,以防止在仪表板上意外点击更新Omise-API版本
引发的问题。
快速入门
如前几节所示,您的代码将类似于以下代码
<?php require_once dirname(__FILE__).'/vendor/autoload.php'; define('OMISE_PUBLIC_KEY', 'pkey_test_***'); define('OMISE_SECRET_KEY', 'skey_test_***'); define('OMISE_API_VERSION', '2017-11-02');
现在,让我们添加获取您的账户信息的代码
$account = OmiseAccount::retrieve(); echo $account['email']; // your email will be printed on a screen.
就是这样!您已经向Opn Payments API发送了请求,简单吧?
请随意将Opn支付网关服务集成到您想要的方式,以使其与您的业务流程相匹配。
如果您需要帮助,请阅读文档和查看示例代码以获取更多信息。
祝您玩得开心!
开发和测试
要运行自动化测试套件,请确保您在本地计算机上已经安装了PHPUnit。然后运行PHPUnit。
cp .env.example .env
make test
- 要生成代码覆盖率测试报告,运行
make coverage
。
贡献
感谢您对Omise PHP的贡献兴趣。我们期待听取您的意见,并愿意审阅您的更改。
以下部分是针对考虑提交更改和/或问题的贡献者的说明。
提交更改
您都可以提交拉取请求。
了解更多关于拉取请求的信息。
提交问题
通过GitHub问题频道提交问题。
了解更多关于提交问题的信息。
许可证
Omise-PHP是在MIT许可证下发布的开源软件。