性能/性能SDK

维护者

详细信息

github.com/formancehq/formance-sdk-php

源代码

问题

安装: 588

依赖: 0

建议者: 0

安全: 0

星标: 2

关注者: 2

分支: 0

公开问题: 1

v3.1.0 2024-09-25 11:53 UTC

Requires

Requires (Dev)

MIT ff6670b20f2bd084acce2b4992725799c82cd8cf

This package is auto-updated.

Last update: 2024-09-25 11:55:30 UTC

README

🏗 欢迎使用您的新SDK！ 🏗

它已成功基于您的OpenAPI规范生成。但是，它尚未准备好用于生产。以下是一些下一步操作

  • 🛠 通过 自定义它 使您的SDK感觉手工制作
  • ♻️ 通过使用 Speakeasy CLI 在本地迭代快速优化您的SDK
  • 🎁 通过 配置自动发布 将您的SDK发布到包管理器
  • ✨ 当准备好用于生产时，请从README中删除此部分

摘要

性能栈API：独特的支付流程的开放、模块化基础

介绍

此API使用 OpenAPI格式 进行文档化。

身份验证

性能栈提供一种身份验证方式

  • OAuth2 OAuth2 - 一个开放协议，允许通过简单和标准的方法从Web、移动和桌面应用程序进行安全的授权。

目录

SDK安装

SDK依赖于 Composer 来管理其依赖项。

要安装SDK并将其添加到现有 composer.json 文件中的依赖项

composer require "formance/formance-sdk"

SDK示例用法

示例

declare(strict_types=1);

require 'vendor/autoload.php';

use formance\stack;
use formance\stack\Models\Operations;

$sdk = stack\SDK::builder()->build();

try {
    $requestSecurity = new Operations\GetVersionsSecurity(
        authorization: "<YOUR_AUTHORIZATION_HERE>",
    );
    $response = $sdk->getVersions($requestSecurity);

    if ($response->getVersionsResponse !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

可用资源和操作

可用方法

Auth

账本

编排

支付

对账

SDK

SDKOrchestrationV1

SDKPaymentsV1

SDKReconciliationV1

SDKSearchV1

SDKV1

SDKV2

SDKWalletsV1

SDKWebhooksV1

搜索

V1

V2

钱包

Webhooks

服务器选择

服务器选择

按索引选择服务器

您可以通过在初始化SDK客户端实例时传递一个服务器索引到server_idx: int可选参数来全局覆盖默认服务器。然后所选服务器将在使用它的操作中用作默认服务器。此表列出了与可用服务器关联的索引

变量

上述一些服务器选项包含变量。如果您想设置这些变量的值，则在初始化SDK客户端实例时可以使用以下可选参数

  • 环境: stack\ServerEnvironment
  • 组织: 字符串

按客户端覆盖服务器URL

默认服务器也可以通过在初始化SDK客户端实例时传递一个URL到server_url: str可选参数来全局覆盖。例如

开发

成熟度

此SDK处于测试版，版本之间可能存在重大更改而无需进行主要版本更新。因此，我们建议将使用绑定到特定包版本。这样，您可以在不进行破坏性更改的情况下每次安装相同版本，除非您有意寻找最新版本。

贡献

虽然我们重视对SDK的开放源代码贡献，但这个库是程序生成的。请随时提交一个PR或Github问题作为概念证明，我们将尽力将其包含在未来版本中！

由Speakeasy创建的SDK