transbank / transbank-sdk
Transbank SDK
Requires
- php: >=7.0
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^5.3.1|^6.5.8|^7.4.5
Requires (Dev)
- dms/phpunit-arraysubset-asserts: ^0.2.1
- phpunit/phpunit: ^9
- squizlabs/php_codesniffer: ~2.0
- dev-master
- 4.0.0
- 3.0.0
- 2.x-dev
- 2.0.10
- 2.0.9
- 2.0.8
- 2.0.7
- 2.0.6
- 2.0.5
- 2.0.4
- 2.0.3
- 2.0.2
- 2.0.1
- 2.0
- 2.0-beta
- 1.x-dev
- 1.10.3
- 1.10.2
- 1.10.1
- 1.10.0
- 1.9.0
- 1.8.2
- 1.8.1
- 1.8.0
- 1.7.3
- 1.7.2
- 1.7.1
- 1.7.0
- 1.6.1
- 1.6.0
- 1.5.3
- 1.5.2
- 1.5.1
- 1.5.0
- 1.4.4
- 1.4.3
- 1.4.2
- 1.4.1
- 1.4.0
- 1.3.2
- 1.3.1
- 1.3.0
- 1.2.2
- 1.2.1
- v1.2.0
- 1.1.1
- 1.1.0
- 1.0.1
- 1.0.0
- dev-feat/use-http-client-with-curl
- dev-develop
- dev-refactor/change-php-docs-imports
This package is auto-updated.
Last update: 2024-09-17 13:41:25 UTC
README
Transbank PHP SDK
要求
- PHP 7.0+
依赖项
为了使用此 SDK,您必须安装以下 PHP 扩展
- ext-curl
- ext-json
- ext-mbstring
安装
使用 Composer 安装
要在项目中使用 SDK,您必须使用 Composer(如果您还没有安装,可以在此处安装),将 SDK 添加为项目的依赖项
"require": { ... "transbank/transbank-sdk": "~2.0" }
然后您必须运行
composer update
您还可以直接从控制台安装
composer require transbank/transbank-sdk:~2.0
安装后...
如果您是第一次在项目中使用 Composer,将创建一个 vendor/
目录,其中包含 SDK 和所需的一切。我们建议您阅读 Composer 的工作原理,但为了说明一个重要点,现在请确保将 vendor/autoload.php
文件包含在您的项目开头。
如果您的项目已经使用 Composer,则库将自动可用,无需进行任何额外操作。
共享主机(不推荐)
如果您使用的是共享主机或无法安装 Composer 的环境,请不要担心:您可以在自己的计算机上安装 Composer,按照前面说明的方式安装包,然后通过 FTP、SSH 或其他方式上传所有项目文件。不需要在服务器上安装 composer。只需要安装 composer 后生成的文件即可。无论如何,我们建议您使用 VPS 或专用服务器,这样您可以更好地控制您的系统。
基本代码示例
我们在本存储库的 examples
目录中留下了几个基本代码示例,建议您查阅。您可以进入该目录,在终端中运行 PHP 服务器来执行此示例。
cd /path/to/this/sdk cd examples php -S 127.0.0.1:8000
然后,只需在您的网络浏览器中打开 [http://127.0.0.1:8000]。
完整示例项目
此外,我们创建了一个示例项目,其中实现了此处提到的所有产品和模式:https://github.com/TransbankDevelopers/transbank-sdk-php-webpay-rest-example/
Transbank 开发者文档
您可以在https://www.transbankdevelopers.cl 网站上找到有关如何使用此 SDK 的全部文档。
与此 SDK 相关的相关文档是
- 使用 Webpay 的入门指南
- 有关环境、商家职责、部署等内容的文档: 环境、商家职责、部署等。
您还可以找到
有关贡献和开发此 SDK 的信息
标准
- 对于提交,我们遵守以下规范:https://chris.beams.io/posts/git-commit/
- 提交消息使用英文。
- 可以在提交的主题中使用类似于 WIP 的标记,用
:
分隔标记,例如:WIP: 这是一个有用的提交信息
- 分支名称也使用英文。
- 假设一个未混合的功能分支是一个未完成的功能。
- 分支名称使用小写字母。
- 单词之间用
-
分隔。 - 分支名称以定义的某些简短前缀标记开始,例如:
feat/tokens-configuration
简短前缀标记
提交
- WIP = 进行中。
分支
- feat = 新功能
- chore = 不面向用户的任务。
- bug = 解决 bug。
所有向 master 的合并都通过拉取请求(Pull Request)进行。
测试
要在本地执行测试,请在终端中执行以下命令。
make
然后执行测试
make test
部署新版本。
要生成新版本,必须创建一个带有标题 "Prepare release X.Y.Z" 的 PR(其中 X
、Y
和 Z
的值对应),并遵循 semver 标准,以确定是否增加 X
(如果有不兼容的更改)、Y
(对于兼容的改进)或 Z
(如果只有 bug 修复)的值。
在该 PR 中应包括以下更改
- 修改
CHANGELOG.md
文件,在开头添加一个新条目X.Y.Z
,用西班牙语解释 SDK 用户的更改 (用户可见的更改)。 - 修改此
README.md
文件,以便示例使用新版本X.Y.Z
在拉取请求获得批准后,将其合并到 master,并立即使用标签 X.Y.Z
在 GitHub 上生成发布。在发布描述中,请添加与 changelog 中相同的内容。
这样 Travis CI 将自动生成库的新版本并将其发布到 Packagist。
安全漏洞
如果你在此项目中发现安全漏洞,请通过电子邮件 transbankdevelopers@continuum.cl 通知我们。我们将尽快处理此事。