pspark/sdk

该软件包最新版本(0.0.7)的许可证信息不可用。

商家REST API的PHP SDK

0.0.7 2024-09-18 09:16 UTC

This package is auto-updated.

Last update: 2024-09-18 09:17:03 UTC


README

您应该有 jwt-keyapi-key 密钥才能使用此SDK通过API。 jwt-key 是一个CSR文件。

生成CSR文件

证书签名请求(.csr)文件用于验证API用户并获得您的 API-Key。该 .csr 文件包含您的API公钥,它将用于验证请求签名。要生成用于签名请求的RSA 4096私钥(存储在 psparkr_secret.key 中),请使用以下命令行

openssl req -new -newkey rsa:4096 -nodes -keyout pspakr_secret.key -out pspark_public_key.csr

确保您将API密钥(pspark_secret.key)安全地保管。不要与任何人分享您的API密钥。要获取您的 API-key,您应该在 cabinet.pspark.io 上上传您的 pspark_public_key

请求示例

以下是一个SDK使用的简单示例。

<?php

declare(strict_types=1);

namespace App;

use PsPark\PsPark;
use PsPark\Config;

```php
$pspark = new PsPark(new Config(jwtKey: 'jwt-key', apiKey: 'api-key'));
$result = $pspark->getBalance(new BalanceRequest(nonce: time()))->asArray();

更多请求示例可以在这里找到。

您可以使用框架的DI(服务提供者等)轻松配置SDK,或创建自己的简单工厂。

验证错误

API没有实现所有RESTFull API要求,并有自己的响应结构。

服务器所有HTTP响应都将有200状态码。因此,如果您的请求有验证错误,代码及其描述将如以下所示在响应体中呈现。

响应示例

{
  "code": 1002,
  "message": "error description",
  "data": {
    //... some data
  }
}

每次当服务器的响应有验证错误时,SDK将抛出 ResponseValidationException 异常。所有类型的验证错误都可以在API文档中找到。