veem/sdk

1.0.0 2019-09-26 03:09 UTC

This package is auto-updated.

Last update: 2024-09-27 01:20:59 UTC


README

Veem PHP SDK 提供了一个接口,使调用 Veem 全球支付 API 更加容易。Veem 全球支付 API

版本信息

  • 最新 SDK 版本:1.0.0
  • 最新支持的 API 端点版本:v1.1

文档

系统要求

  1. SDK 在 PHP 7 及更高版本 上运行。
  2. 一个 开发者 账户
  3. 一个 拥有客户账户的应用 以及相关的客户端 ID 和密钥(授权流程/客户端凭证流程)

首次使用说明

  1. 使用以下命令安装 composer: composer require veem/sdk
  2. 在您的 PHP 项目中开始使用 Veem SDK 类

测试代码

要本地测试代码,请按照以下步骤操作

  1. 切换到项目目录
  2. 客户端可以集成授权流程或客户端凭证流程;
  3. 对于授权流程,创建一个 VeemContext 对象,填写 clientIdclientSecretauthorizationCoderedirectUrl(可选)。
  4. 对于客户端凭证流程,创建一个 VeemContext 对象,填写 clientIdclientSecret
  5. 要使用所有 Veem 全球支付 API,请将 VeemContext 对象作为构造函数参数传递给 VeemClient,并调用访问令牌方法以进行步骤 3 或步骤 4 的情况。

获取 OAuth 令牌

要从开发者门户获取访问令牌;

使用 Veem 登录 - 登录到 开发者门户

创建应用- 通过提供 NameOAuth2 重定向 URLPayment Status Webhooks 创建一个新的应用。

创建客户- 通过提供 Business NameCountryPrimary Email 创建一个新的客户。

获取凭证- 前往应用,选择 Customer 并复制 Access Token

要程序化地获取 access token,请获取客户端 ID、客户端密钥(可选的授权流程重定向 URL)。

use Veem\VeemContext;
use Veem\clients\VeemClient;

$context = new VeemContext("Test-46ecbf0b", "34b20dcf-6e6c-4bd4-83c3-159d5b7c3c27");
$veem = new VeemClient($context, $loginFromClientCredentials = true);

// or

$veem = new VeemClient($context);
$veem->getTokenFromClientCredentials();

发票客户端示例

以下示例展示了如何使用 Invoice Client 发送发票


use Veem\VeemContext;
use Veem\clients\VeemClient;

// define a VeemClient Context Manager and auto login.
$context = new VeemContext("Test-46ecbf0b", "34b20dcf-6e6c-4bd4-83c3-159d5b7c3c27");
$veem = new VeemClient($context, $loginFromClientCredentials = true);

// define an InvoiceRequest

$account = new Account();
$account->setType('Business')
        ->setEmail('devsupport+gbp@veem.com')
        ->setFirstName('Wei')
        ->setLastName('Chen')
        ->setBusinessName('GBP Veem Wei')
        ->setCountryCode('GB')
        ->setPhoneCountryCode('44')
        ->setPhone('03700100222');
$amount = new Amount($number = 50, $currency = 'GBP');
$invoiceRequest = new Invoice();
$invoiceRequest->setAmount($amount)->setPayer($account);

// create an invoice
$invoice = $veem->getInvoiceClient()->create($invoiceRequest);

更多示例可以在 examples 文件夹下找到