-
API
-
The terms `API` (Application Programming Interface) and `Endpoint` are used somewhat interchangeablyMore...
- 获取API信息(根)
- 获取API配置
- 获取JSON Web密钥(JWK)
- 获取JSON Web密钥(JWK)URI
- 获取当前通话的通话上下文
- 获取连接器状态(环回)
- 获取适配器信息
- 获取速率限制信息
- 获取银行的适配器信息
-
-
Account
-
The thing that tokens of value (money) come in and out of. An account has one or more `owners` whichMore...
- 创建帐号
- 创建帐户属性
- 创建帐户(POST)
- 在所有银行(私人)获取帐户
- 在银行获取Firehose帐户
- 在银行获取帐户。
- 在银行获取帐户(仅ID)。
- 在银行获取帐户(最低)。
- 按ID获取帐户(完整)
- 按ID获取帐户(核心)
- 更新帐户属性
- 更新帐户标签。
- 更新账户。
- 查看可用资金
- 获取帐户余额
- 获取持有的帐户
- 获取支票簿订单
-
-
Bank
-
A Bank (aka Space) represents a financial institution, brand or organizational unit under which resMore...
- 取得银行
- 建立银行
- 映射(类型->字符串)
- 映射(类型->字符串)
- 获取银行
-
-
Consent
-
Consents provide a mechanism by which a third party App or User can access resources on behalf of aMore...
- 取得同意
- 回答同意挑战
- 建立同意书(EMAIL)
- 建立同意书(SMS)
- 撤销同意
-
-
Consumer
-
The "consumer" of the API, i.e. the web, mobile or serverside "App" that calls on the OBP API on beMore...
- 启用或禁用消费者
- 吸引消费者
- 吸引消费者
- 吸引消费者(登录用户)
- 更新使用者RedirectUrl
- 获取消费者的通话限制
- 设置消费者的通话限制
-
-
Counterparty Metadata
- 创建其他帐户专用别名
- 删除交易对手私人别名
- 删除其他银行帐户的更多信息。
- 删除其他银行帐户的网址。
- 删除对方公共别名
- 删除对方公司位置。
- 删除对方图片网址
- 删除对方开放公司网址
- 删除对方的物理位置。
- 将公共别名添加到其他银行帐户。
- 将公司位置添加到交易对手
- 将图片网址添加到其他银行帐户。
- 将实际位置添加到其他银行帐户。
- 将开放公司网址添加到交易对手
- 将网址添加到其他银行帐户。
- 更新交易对手公司位置
- 更新交易对手图片网址
- 更新交易对手更多信息
- 更新交易对手的公开公司网址
- 更新交易对手的实际位置
- 更新交易对手私人别名
- 更新其他银行帐户的公共别名。
- 更新其他银行帐户的网址。
- 添加交易对手更多信息
- 获取其他帐户专用别名
- 获取其他帐户元数据。
- 获取其他银行帐户的公共别名。
-
Customer
-
The legal entity that has the relationship to the bank. Customers are linked to Users via `User CusMore...
- 为客户增加税收居住
- 创建信用额度订单请求
- 创建客户。
- 创建用户客户链接。
- 删除客户地址
- 删除税收居民
- 向客户添加地址
- 在银行获取当前用户的客户
- 按MOBILE_PHONE_NUMBER获取客户
- 更新客户分支
- 更新客户地址
- 更新客户数量
- 更新客户的信用等级和来源
- 更新客户的信用额度
- 更新客户的其他数据
- 更新客户的手机号码
- 更新客户的电子邮件
- 更新客户的身份数据
- 添加社交媒体句柄
- 获取CRM活动
- 获取Firehose客户
- 获取信用额度订单请求
- 获取客户地址
- 获取客户的税收住所
- 获取客户社交媒体句柄
- 获取当前用户的客户
- 通过CUSTOMER_ID获取客户
- 通过CUSTOMER_NUMBER获取客户
- 通过请求ID获取信用额度订单请求
-
-
Method Routing
-
Open Bank Project can have different connectors, to connect difference data sources. We supportMore...
- 删除方法
- 更新方法
- 添加方法
- 获取MethodRoutings
-
-
Transaction
-
Transactions are records of successful movements of value into or out of an `Account`. OBP TransacMore...
- 获取其他交易帐户
- 获取帐户交易(完整)
- 获取帐户交易(核心)
- 获取帐户的Firehose交易
- 通过ID获取交易。
-
-
User
-
The entity that accesses the API with a login / authorisation token and has access to zero or moreMore...
- 创建密码重置网址
- 创建用户。
- 创建用户身份验证上下文
- 创建用户身份验证上下文更新
- 删除用户的身份验证上下文
- 删除用户身份验证上下文
- 刷新用户。
- 回答身份验证上下文更新挑战
- 获取所有用户
- 获取用户身份验证上下文
- 获取用户锁定状态
- 获取用户(当前)
- 解锁用户
- 通过USERNAME获取用户
- 通过USER_ID获取用户
- 通过电子邮件地址获取用户
-
-
API
- 获取API信息(根)
- 获取API配置
- 获取JSON Web密钥(JWK)
- 获取JSON Web密钥(JWK)URI
- 获取当前通话的通话上下文
- 获取连接器状态(环回)
- 获取适配器信息
- 获取速率限制信息
- 获取银行的适配器信息
-
ATM
-
Account
- 创建帐号
- 创建帐户属性
- 创建帐户(POST)
- 在所有银行(私人)获取帐户
- 在银行获取Firehose帐户
- 在银行获取帐户。
- 在银行获取帐户(仅ID)。
- 在银行获取帐户(最低)。
- 按ID获取帐户(完整)
- 按ID获取帐户(核心)
- 更新帐户属性
- 更新帐户标签。
- 更新账户。
- 查看可用资金
- 获取帐户余额
- 获取持有的帐户
- 获取支票簿订单
-
Account Application
-
Account Metadata
-
Account Public
-
Bank
-
Branch
-
Card
-
Consent
-
Consumer
-
Counterparty
-
Counterparty Metadata
- 创建其他帐户专用别名
- 删除交易对手私人别名
- 删除其他银行帐户的更多信息。
- 删除其他银行帐户的网址。
- 删除对方公共别名
- 删除对方公司位置。
- 删除对方图片网址
- 删除对方开放公司网址
- 删除对方的物理位置。
- 将公共别名添加到其他银行帐户。
- 将公司位置添加到交易对手
- 将图片网址添加到其他银行帐户。
- 将实际位置添加到其他银行帐户。
- 将开放公司网址添加到交易对手
- 将网址添加到其他银行帐户。
- 更新交易对手公司位置
- 更新交易对手图片网址
- 更新交易对手更多信息
- 更新交易对手的公开公司网址
- 更新交易对手的实际位置
- 更新交易对手私人别名
- 更新其他银行帐户的公共别名。
- 更新其他银行帐户的网址。
- 添加交易对手更多信息
- 获取其他帐户专用别名
- 获取其他帐户元数据。
- 获取其他银行帐户的公共别名。
-
Customer
- 为客户增加税收居住
- 创建信用额度订单请求
- 创建客户。
- 创建用户客户链接。
- 删除客户地址
- 删除税收居民
- 向客户添加地址
- 在银行获取当前用户的客户
- 按MOBILE_PHONE_NUMBER获取客户
- 更新客户分支
- 更新客户地址
- 更新客户数量
- 更新客户的信用等级和来源
- 更新客户的信用额度
- 更新客户的其他数据
- 更新客户的手机号码
- 更新客户的电子邮件
- 更新客户的身份数据
- 添加社交媒体句柄
- 获取CRM活动
- 获取Firehose客户
- 获取信用额度订单请求
- 获取客户地址
- 获取客户的税收住所
- 获取客户社交媒体句柄
- 获取当前用户的客户
- 通过CUSTOMER_ID获取客户
- 通过CUSTOMER_NUMBER获取客户
- 通过请求ID获取信用额度订单请求
-
Customer Meeting
-
Customer Message
-
Data Warehouse
-
Direct Debit
-
Documentation
-
Dynamic Entity
-
FX
-
KYC
-
Method Routing
-
Metric
-
Product
-
Product Collection
-
Role
- 为用户添加权利。
- 删除权利
- 删除权利请求
- 添加当前用户的权利请求。
- 获取一家银行的权益
- 获取当前用户的权利。
- 获取当前用户的权利请求。
- 获取所有权利
- 获取所有权利请求
- 获取用户权利
- 获取用户的权利请求。
- 获取角色
- 获取银行用户的权利。
-
Sandbox
-
Scope
-
Standing Order
-
System View
-
Transaction
-
Transaction Metadata
- 删除where标记。
- 删除叙述。
- 删除图片
- 删除标签。
- 删除评论。
- 更新where标记。
- 更新叙述。
- 添加where标记。
- 添加叙述。
- 添加图像。
- 添加标签。
- 添加评论。
- 获取图像。
- 获取标签。
- 获取标签。
- 获取评论。
- 获得叙述。
-
Transaction Request
- 保存历史交易
- 映射(类型->字符串)
- 映射(类型->字符串)
- 映射(类型->字符串)
- 映射(类型->字符串)
- 映射(类型->字符串)
- 映射(类型->字符串)
- 映射(类型->字符串)
- 映射(类型->字符串)
- 映射(类型->字符串)
- 获取支持的交易请求类型
-
User
- 创建密码重置网址
- 创建用户。
- 创建用户身份验证上下文
- 创建用户身份验证上下文更新
- 删除用户的身份验证上下文
- 删除用户身份验证上下文
- 刷新用户。
- 回答身份验证上下文更新挑战
- 获取所有用户
- 获取用户身份验证上下文
- 获取用户锁定状态
- 获取用户(当前)
- 解锁用户
- 通过USERNAME获取用户
- 通过USER_ID获取用户
- 通过电子邮件地址获取用户
-
View
- 创建视图。
- 删除检视
- 授予用户访问视图列表的权限。
- 授予用户访问视图的权限。
- 撤消对一个视图的访问。
- 撤消对帐户中所有视图的访问权限
- 更新视图。
- 获取帐户视图。
- 获取用户的帐户访问权限。
- 获得访问权限。
-
WebUi Props
-
Webhook
v5.1.0 (267 APIs)
获取指标
{
"metrics":[{
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"url":"www.openbankproject.com",
"date":"2017-09-18T22:00:00Z",
"user_name":"OBP",
"app_name":"SOFI",
"developer_email":"eveline@example.com",
"implemented_by_partial_function":"getBanks",
"implemented_in_version":"v210",
"consumer_id":"123",
"verb":"get",
"correlation_id":"v8ho6h5ivel3uq7a5zcnv0w1",
"duration":39
}]
}
-
CanReadMetrics
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
获取汇总指标
返回有关api使用情况的汇总指标。总计数,响应时间(以毫秒为单位)等。
应该能够过滤以下字段
例如:/ management / aggregate-metrics?from_date = 2017-09-19T02:31:05.000Z&to_date = 2017-09-19T02:31:05.000Z&consumer_id = 5
&user_id = 66214b8e-259e-44ad-8868-3eb47be70646&implemented_by_partial_function = getTransactionsForBankAccount
&implemented_in_version = v3.0.0&url = / obp / v3.0.0 / banks / gh.29.uk / accounts / 8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0 / owner / transactions
&verb = GET&anon = false&app_name = MapperPostman
&exclude_app_names = API-EXPLORER,API-Manager,SOFI,空
1个from_date(默认为当前日期的前一天):例如:from_date = 2017-09-19T02:31:05.000Z
2 to_date(默认为当前日期),例如:to_date = 2017-09-19T02:31:05.000Z
3 Consumer_id(如果为null,则忽略)
4 user_id(如果为null,则忽略)
5 anon(如果忽略null)仅支持两个值:true(返回user_id为null的位置)或false(返回user_id不为null的位置。)
6 url(如果为null,则忽略),注意:不能包含'&'。
7 app_name(如果为null,则忽略)
8 Implemented_by_partial_function(如果为null,则忽略),
9 Implemented_in_version(如果为null则忽略)
10个动词(如果为null,则忽略)
11correlation_id(如果为null,则忽略)
12个持续时间(如果忽略null)非数字字符将被忽略
13 exclude_app_names(如果为null则忽略)。例如:&exclude_app_names = API-EXPLORER,API-Manager,SOFI,null
14 exclude_url_patterns(如果为null,则忽略)。您可以设计自己的SQL NOT LIKE模式。例如:&exclude_url_patterns =%management / metrics%,%management / aggregate-metrics%
15 exclude_implemented_by_partial_functions(如果为null则忽略)。例如:&exclude_implemented_by_partial_functions = getMetrics,getConnectorMetrics,getAggregateMetrics
身份验证是强制性的
{
"count":7076,
"average_response_time":65.21,
"minimum_response_time":1.0,
"maximum_response_time":9039.0
}
-
CanReadAggregateMetrics
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
获取连接器指标
获取所有指标
需要CanGetConnectorMetrics角色
过滤第1部分。将参数过滤 (没有通配符等)到GET / management / connector / metrics
应该能够根据以下指标字段进行过滤
例如:/ management / connector / metrics?from_date = 2017-09-19&to_date = 2017-09-19&limit = 50&offset = 2
1个from_date(默认为当前日期之前的一周):例如:from_date = 2017-09-19
2 to_date(默认为当前日期),例如:to_date = 2017-09-19
3个限制(用于分页:默认为1000),例如:limit = 2000
4个偏移量(对于分页:零索引,默认为0),例如:offset = 10
例如:/ management / connector / metrics?from_date = 2017-09-19&to_date = 2017-09-19&limit = 100&offset = 300
其他过滤器:
5 connector_name(如果为null,则忽略)
6 function_name(如果为null,则忽略)
7correlation_id(如果为null,则忽略)
{
"metrics":[{
"connector_name":"mapper",
"function_name":"getBanks",
"correlation_id":"12345",
"date":"2017-09-18T22:00:00Z",
"duration":1000
}]
}
-
CanGetConnectorMetrics
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-10005: Invalid Date Format. Could not convert value to a Date.
- OBP-50000: Unknown Error.
获取顶级API
获取有关最受欢迎的API的指标。例如:总计数,响应时间(以毫秒为单位)等。
应该能够过滤以下字段
例如:/management/metrics/top-apis?from_date=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z&consumer_id=5
&user_id = 66214b8e-259e-44ad-8868-3eb47be70646&implemented_by_partial_function = getTransactionsForBankAccount
&implemented_in_version = v3.0.0&url = / obp / v3.0.0 / banks / gh.29.uk / accounts / 8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0 / owner / transactions
&verb = GET&anon = false&app_name = MapperPostman
&exclude_app_names = API-EXPLORER,API-Manager,SOFI,空
1个from_date(默认为当前日期的前一天):例如:from_date = 2017-09-19T02:31:05.000Z
2 to_date(默认为当前日期),例如:to_date = 2017-09-19T02:31:05.000Z
3 Consumer_id(如果为null,则忽略)
4 user_id(如果为null,则忽略)
5 anon(如果忽略null)仅支持两个值:true(返回user_id为null的位置)或false(返回user_id不为null的位置。)
6 url(如果为null,则忽略),注意:不能包含'&'。
7 app_name(如果为null,则忽略)
8 Implemented_by_partial_function(如果为null,则忽略),
9 Implemented_in_version(如果为null则忽略)
10个动词(如果为null,则忽略)
11correlation_id(如果为null,则忽略)
12个持续时间(如果忽略null)非数字字符将被忽略
13 exclude_app_names(如果为null则忽略)。例如:&exclude_app_names = API-EXPLORER,API-Manager,SOFI,null
14 exclude_url_patterns(如果为null,则忽略)。您可以设计自己的SQL NOT LIKE模式。例如:&exclude_url_patterns =%management / metrics%,%management / aggregate-metrics%
15 exclude_implemented_by_partial_functions(如果为null则忽略)。例如:&exclude_implemented_by_partial_functions = getMetrics,getConnectorMetrics,getAggregateMetrics
身份验证是强制性的
{
"top_apis":[{
"count":7076,
"Implemented_by_partial_function":"getBanks",
"implemented_in_version":"v1.2.1"
}]
}
-
CanReadMetrics
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-10016: Incorrect filter Parameters in URL.
- OBP-30042: Could not get the top apis from database.
- OBP-50000: Unknown Error.
获得顶级消费者
获取有关API使用量最大消费方的指标,例如总数,消费者ID和app_name。
应该能够过滤以下字段
例如:/management/metrics/top-consumers?from_date=2017-09-19T02:31:05.000Z&to_date=2017-05-22T01:02:03.000Z&consumer_id=5
&user_id = 66214b8e-259e-44ad-8868-3eb47be70646&implemented_by_partial_function = getTransactionsForBankAccount
&implemented_in_version = v3.0.0&url = / obp / v3.0.0 / banks / gh.29.uk / accounts / 8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0 / owner / transactions
&verb = GET&anon = false&app_name = MapperPostman
&exclude_app_names = API-EXPLORER,API-Manager,SOFI,空
&limit = 100
1个from_date(默认为当前日期的前一天):例如:from_date = 2017-09-19T02:31:05.000Z
2 to_date(默认为当前日期),例如:to_date = 2017-09-19T02:31:05.000Z
3 Consumer_id(如果为null,则忽略)
4 user_id(如果为null,则忽略)
5 anon(如果忽略null)仅支持两个值:true(返回user_id为null的位置)或false(返回user_id不为null的位置。)
6 url(如果为null,则忽略),注意:不能包含'&'。
7 app_name(如果为null,则忽略)
8 Implemented_by_partial_function(如果为null,则忽略),
9 Implemented_in_version(如果为null则忽略)
10个动词(如果为null,则忽略)
11correlation_id(如果为null,则忽略)
12个持续时间(如果忽略null)非数字字符将被忽略
13 exclude_app_names(如果为null则忽略)。例如:&exclude_app_names = API-EXPLORER,API-Manager,SOFI,null
14 exclude_url_patterns(如果为null,则忽略)。您可以设计自己的SQL NOT LIKE模式。例如:&exclude_url_patterns =%management / metrics%,%management / aggregate-metrics%
15 exclude_implemented_by_partial_functions(如果为null则忽略)。例如:&exclude_implemented_by_partial_functions = getMetrics,getConnectorMetrics,getAggregateMetrics
16个限制(用于分页:默认为50),例如:limit = 200
身份验证是强制性的
{
"top_consumers":[{
"count":7076,
"consumer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"app_name":"Api Explorer",
"developer_email":"eveline@example.com"
}]
}
-
CanReadMetrics
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-10016: Incorrect filter Parameters in URL.
- OBP-30045: Could not get the top consumers from database.
- OBP-50000: Unknown Error.
通过Elasticsearch搜索API指标。
通过Elastic Search搜索对此API实例进行的API调用。
需要登录。
需要CanSearchMetrics授权才能搜索指标数据。
参数:
esType-elasticsearch类型
简单查询:
q-plain_text_query
df-搜索的默认字段
sort-要排序的字段
大小-返回的匹配数,默认为10
from-显示热门歌曲,起始于
json查询:
来源-JSON_query_(网址转义)
用法示例:
/ search / metrics / q = findThis
要么:
/ search / metrics / source = {“ query”:{“ query_string”:{“ query”:“ findThis”}}}
注意!!
整个JSON查询字符串必须使用URL编码:
- 对于{使用%7B
- 对于},请使用%7D
- 对于:使用%3A
- 对于“使用%22
等等..
仅q,source和esType传递给Elastic
弹性简单查询: https : //www.elastic.co/guide/en/elasticsearch/reference/current/search-uri-request.html
弹性JSON查询: https : //www.elastic.co/guide/zh-CN/elasticsearch/reference/current/query-filter-context.html
{
"jsonString":"{}"
}
-
CanSearchMetrics
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.