README

以下页面为您提供有关如何使用我们API的一些基本信息。
实际的API服务文档随后将在下方显示。您可以使用菜单在API部分之间跳转。

此页面内置了HTTP(S)客户端，因此您可以直接在此页面上测试服务，通过在相应服务中填写请求参数和/或正文，然后点击TRY按钮。请注意，您需要授权才能成功调用API。要授权，请参考访问部分中的“授权”部分，或者如果您已经有有效的用户令牌，只需使用左侧的快速授权。
请记住，所有用户管理功能都应该在访问中查找。

您还应该查看Web Form 2.0 公共文档以及访问公共文档以获取更多信息。如果您需要有关API的帮助，请联系 support@finapi.io。
<h2 id="general-information">基本信息<h3 id="general-request-ids">请求ID在调用任何API时，您可以通过名为“X-Request-Id”的标头传递请求ID。请求ID可以是一个最多255个字符的任意字符串。传递更长的字符串将导致错误。

如果您未传递请求ID进行调用，finAPI将内部生成一个随机ID。

请求ID始终以名为“X-Request-Id”的标头返回到服务的响应中。

我们强烈建议始终传递一个（最好是唯一的）请求ID，并在您发出请求或接收响应时（尤其是错误响应的情况下）将其包含在客户端应用程序日志中。finAPI在其端上也记录请求ID。有一个请求ID可以帮助finAPI支持团队更有效地工作并更快地解决票证。
<h3 id="type-coercion">类型强制转换为了简化某些语言（这些语言不原生支持高精度数字表示）的集成，Web Form 2.0 API支持对openAPI类型number的宽松类型绑定，该类型用于金额字段。如果您使用这些语言之一，为了避免来自float值的精度错误，您可以将金额作为string传递。

<h3 id="general-faq">常见问题解答是否有finAPI SDK？
目前我们不提供原生SDK，但可以通过OpenAPI为几乎任何目标语言生成SDK。使用此页面的“下载SDK”按钮进行SDK生成。

为什么我需要在此页面上调用服务时不断进行授权？

需求

PHP 7.4 及更高版本。也应与 PHP 8.0 兼容。

Composer

要通过 Composer 安装绑定，请将以下内容添加到 composer.json

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https:////.git"
    }
  ],
  "require": {
    "/": "*@dev"
  }
}

然后运行 composer install

手动安装

下载文件并包含 autoload.php

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

入门指南

请按照安装流程进行操作，然后运行以下命令

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure OAuth2 access token for authorization: BearerAccessToken
$config = OpenAPIWebForm\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPIWebForm\Client\Api\AccountInformationServicesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$bank_connection_update_task_details = new \OpenAPIWebForm\Client\Model\BankConnectionUpdateTaskDetails(); // \OpenAPIWebForm\Client\Model\BankConnectionUpdateTaskDetails

try {
    $result = $apiInstance->createBankConnectionUpdateTask($bank_connection_update_task_details);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountInformationServicesApi->createBankConnectionUpdateTask: ', $e->getMessage(), PHP_EOL;
}

API 端点

所有 URI 都相对于 https://webform-sandbox.finapi.io

模型

授权

BearerAccessToken

类型: OAuth
流程: password
授权 URL: ``
作用域:
- all: 无限制

测试

要运行测试，请使用

composer install
vendor/bin/phpunit

作者

关于此包

此 PHP 包是由 OpenAPI Generator 项目自动生成的

API 版本: 2.685.0
构建包: org.openapitools.codegen.languages.PhpClientCodegen

eciboadaptech / finapi-webform

维护者

详细信息