⯆

API Explorer

My Collections

API
- The terms `API` (Application Programming Interface) and `Endpoint` are used somewhat interchangeably
  More...
- 获取API信息（根）
- 获取API配置
- 获取JSON Web密钥（JWK）
- 获取JSON Web密钥（JWK）URI
- 获取当前通话的通话上下文
- 获取连接器状态（环回）
- 获取适配器信息
- 获取速率限制信息
- 获取银行的适配器信息
ATM
Account
- The thing that tokens of value (money) come in and out of. An account has one or more `owners` which
  More...
- 创建帐号
- 创建帐户属性
- 创建帐户（POST）
- 在所有银行（私人）获取帐户
- 在银行获取Firehose帐户
- 在银行获取帐户。
- 在银行获取帐户（仅ID）。
- 在银行获取帐户（最低）。
- 按ID获取帐户（完整）
- 按ID获取帐户（核心）
- 更新帐户属性
- 更新帐户标签。
- 更新账户。
- 查看可用资金
- 获取帐户余额
- 获取持有的帐户
- 获取支票簿订单
Account Application
Account Metadata
Account Public
Bank
- A Bank (aka Space) represents a financial institution, brand or organizational unit under which res
  More...
- 取得银行
- 建立银行
- 映射（类型->字符串）
- 映射（类型->字符串）
- 获取银行
Branch
Card
Consent
- Consents provide a mechanism by which a third party App or User can access resources on behalf of a
  More...
- 取得同意
- 回答同意挑战
- 建立同意书（EMAIL）
- 建立同意书（SMS）
- 撤销同意
Consumer
- The "consumer" of the API, i.e. the web, mobile or serverside "App" that calls on the OBP API on be
  More...
- 启用或禁用消费者
- 吸引消费者
- 吸引消费者
- 吸引消费者（登录用户）
- 更新使用者RedirectUrl
- 获取消费者的通话限制
- 设置消费者的通话限制
Counterparty
Counterparty Metadata
Customer
Customer Meeting
Customer Message
Data Warehouse
Direct Debit
Documentation
Dynamic Entity
FX
KYC
Method Routing
- Open Bank Project can have different connectors, to connect difference data sources. We support
  More...
- 删除方法
- 更新方法
- 添加方法
- 获取MethodRoutings
Metric
Product
Product Collection
Role
Sandbox
- 创建沙箱
Scope
Standing Order
System View
Transaction
- Transactions are records of successful movements of value into or out of an `Account`. OBP Transac
  More...
- 获取其他交易帐户
- 获取帐户交易（完整）
- 获取帐户交易（核心）
- 获取帐户的Firehose交易
- 通过ID获取交易。
Transaction Metadata
Transaction Request
User
- The entity that accesses the API with a login / authorisation token and has access to zero or more
  More...
- 创建密码重置网址
- 创建用户。
- 创建用户身份验证上下文
- 创建用户身份验证上下文更新
- 删除用户的身份验证上下文
- 删除用户身份验证上下文
- 刷新用户。
- 回答身份验证上下文更新挑战
- 获取所有用户
- 获取用户身份验证上下文
- 获取用户锁定状态
- 获取用户（当前）
- 解锁用户
- 通过USERNAME获取用户
- 通过USER_ID获取用户
- 通过电子邮件地址获取用户
View
WebUi Props
Webhook

Log off

v5.1.0 (267 APIs)

API Host: https://api3.openbankproject.com

测试资源文档

我只是一个测试资源文档

这应该是H1

这应该是H2

这应该是H3

这应该是H4

这是包含两个项目的列表：

他们自己有下划线_

单词周围有下划线

有下划线_in_words

有“ underscores_in_words_inside_quotes”

有（underscores_in_words_in_brackets）

等 ...

Typical Successful Response:

								
									{
  "jsonString":"{}"
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv1.4.0, function_name: by testResourceDoc, operation_id: OBPv1.4.0-testResourceDoc Tags: Documentation,

获取API词汇表

Map（类型->对象，属性-> Map（html->地图（类型->字符串），降价->地图（类型->字符串）））

Typical Successful Response:

								
									{
  "glossary_items":[{
    "title":"Dr.",
    "description":{
      "markdown":"String",
      "html":"String"
    }
  }]
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv3.0.0, function_name: by glossary, operation_id: OBPv3.0.0-glossary Tags: Documentation,

获取Swagger文档

以Swagger格式返回有关此服务器上RESTful资源的文档。

API_VERSION是您想要有关例如v3.0.0的文档的版本

您可以使用'tags'网址参数过滤此端点，例如？tags = Account，Bank

（给所有端点一个或多个用于分组的标签）

您可以使用'functions'url参数过滤此端点，例如？functions = getBanks，bankById

（每个端点通过“功能”在OBP Scala代码中实现）

您可以使用“目录” URL参数过滤此端点，例如？core =＆psd2 = true＆obwg =

有关更多信息，请参见Resource Doc端点。

Typical Successful Response:

								
									{
  "jsonString":"{}"
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv1.4.0, function_name: by getResourceDocsSwagger, operation_id: OBPv1.4.0-getResourceDocsSwagger Tags: Documentation, API,

获取消息文档

映射（类型->字符串）

Typical Successful Response:

								
									{
  "message_docs":[{
    "process":"getAccounts",
    "message_format":"KafkaV2017",
    "outbound_topic":"to.obp.api.1.caseclass.OutboundGetAccounts",
    "inbound_topic":"from.obp.api.1.to.adapter.mf.caseclass.OutboundGetAccounts",
    "description":"get Banks",
    "example_outbound_message":{
      "jsonString":"{}"
    },
    "example_inbound_message":{
      "jsonString":"{}"
    },
    "outboundAvroSchema":{
      "jsonString":"{}"
    },
    "inboundAvroSchema":{
      "jsonString":"{}"
    },
    "adapter_implementation":{
      "group":"CORE",
      "suggested_order":3
    }
  }]
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv2.2.0, function_name: by getMessageDocs, operation_id: OBPv2.2.0-getMessageDocs Tags: Documentation, API,

获取消息文档招摇

映射（类型->字符串）

Typical Successful Response:

								
									{
  "message_docs":[{
    "process":"getAccounts",
    "message_format":"KafkaV2017",
    "outbound_topic":"to.obp.api.1.caseclass.OutboundGetAccounts",
    "inbound_topic":"from.obp.api.1.to.adapter.mf.caseclass.OutboundGetAccounts",
    "description":"get Banks",
    "example_outbound_message":{
      "jsonString":"{}"
    },
    "example_inbound_message":{
      "jsonString":"{}"
    },
    "outboundAvroSchema":{
      "jsonString":"{}"
    },
    "inboundAvroSchema":{
      "jsonString":"{}"
    },
    "adapter_implementation":{
      "group":"CORE",
      "suggested_order":3
    }
  }]
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv3.1.0, function_name: by getMessageDocsSwagger, operation_id: OBPv3.1.0-getMessageDocsSwagger Tags: Documentation, API,

获取资源文档。

获取有关此服务器上RESTful资源的文档，包括POST和PUT请求的示例正文。

这是用于记录OBP端点的本机数据格式。每个端点都有一个在源代码中定义的Resource Doc（Scala案例类）。

OBP API资源管理器使用此端点来显示和使用API文档。

大多数（但不是全部）字段也都可以使用摇摇欲坠的格式。（Swagger终结点是从“资源文档”构建的。）

API_VERSION是您想要有关例如v3.0.0的文档的版本

您可以使用标签参数过滤此端点，例如？tags = Account，Bank

您可以使用功能参数过滤此端点，例如？functions = enableDisableConsumers，getConnectorMetrics

有关可能的函数值，请参见此终结点返回的JSON中的Implemented_by.function或OBP源代码或API Explorer的页脚，它们会产生逗号分隔的函数列表，这些函数列表反映了服务器或API Explorer基于标记等进行过滤。

您可以使用“目录” URL参数过滤此端点，例如？core =＆psd2 = true＆obwg =

有关更多信息，请参见Resource Doc端点。

operation_id是“ v”，版本和功能的串联，并且应该是唯一的（用于DOM元素ID等，可能用于链接到源代码）
版本引用定义了API调用的版本。
function是实现此端点的（标量）部分函数。每个API版本都是唯一的。
对于根调用，request_url为空，否则为路径。它包含标准前缀（例如/ obp）和实现的版本（定义此端点的版本），例如/obp/v1.2.0/resource
对于根调用，指定路径（建议使用）为空，否则为路径。它包含标准前缀（例如/ obp）和调用中指定的版本，例如/obp/v3.1.0/resource。在OBP中，首先在request_url上使端点可用，但是在更高版本（specified_url）下通常使相同的资源（函数调用）可用。要访问所有端点的最新版本，请使用OBP实例上可用的最新版本，例如/obp/v3.1.0-要获取原始版本，请使用request_url。我们建议使用指定的URL，因为非语义上的改进很可能会应用于以后的调用实现中。
摘要是与草率术语一致的简短描述。
说明可能包含html标记（从服务器上的markdown生成）。

Typical Successful Response:

								
									{
  "jsonString":"{}"
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv1.4.0, function_name: by getResourceDocsObp, operation_id: OBPv1.4.0-getResourceDocsObp Tags: Documentation, API,

Get documentation about the selected endpoints as:

Resource Docs JSON
Swagger 2 JSON
中文版本
Partial Functions

Note: You can list just the APIs that are implemented in a certain version by appending &native=true to the index URL.
API_Explorer Commit

Featured APIs

API Explorer

v5.1.0 (267 APIs)

测试资源文档

这应该是H1

这应该是H2

这应该是H3

这应该是H4

获取API词汇表

获取Swagger文档

获取消息文档

获取消息文档招摇

获取资源文档。