API Explorer

v4.0.0 zh (267 APIs)

Bank
Accounts
Views
Counterparties
Transactions

获取API信息(根)

返回有关以下内容的信息:

  • API版本
  • 信息托管
  • 托管信息
  • 能源信息
  • Git提交
Typical Successful Response:

								
									
{ "version":"String", "version_status":"String", "git_commit":"String", "connector":"String", "hosted_by":{ "organisation":"String", "email":"String", "phone":"String", "organisation_website":"String" }, "hosted_at":{ "organisation":"Amazon", "organisation_website":"https://aws.amazon.com/" }, "energy_source":{ "organisation":"Stromio", "organisation_website":"https://www.stromio.de/" } }
Possible Errors:
  • OBP-50000: Unknown Error.
  • no connector set
Implemented in OBPv4.0.0 by root

获取API配置

返回有关以下内容的信息:

  • 默认的bank_id
  • Akka配置
  • 弹性搜索配置
  • 缓存功能
Typical Successful Response:

								
									
{ "akka":{ "ports":[{ "property":"default", "value":"8080" }], "log_level":"Debug", "remote_data_secret_matched":true }, "elastic_search":{ "metrics":[{ "property":"String", "value":"Mapper" }], "warehouse":[{ "property":"String", "value":"ElasticSearch" }] }, "cache":[{ "function_name":"getBanks", "ttl_in_seconds":5 }], "scopes":{ "require_scopes_for_all_roles":true, "require_scopes_for_listed_roles":["CanCreateUserAuthContextUpdate"] } }
Required Roles:
  • CanGetConfig - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by config

获取JSON Web密钥(JWK)

获取服务器的公共JSON Web密钥(JWK)集和证书链。
客户端应用程序需要验证ID令牌,自包含访问令牌和其他已发布的对象。

Typical Successful Response:

								
									
{ "kty":"RSA", "e":"AQAB", "use":"sig", "kid":"fr6-BxXH5gikFeZ2O6rGk0LUmJpukeswASN_TMW8U_s", "n":"hrB0OWqg6AeNU3WCnhheG18R5EbQtdNYGOaSeylTjkj2lZr0_vkhNVYvase-CroxO4HOT06InxTYwLnmJiyv2cZxReuoVjTlk--olGu-9MZooiFiqWez0JzndyKxQ27OiAjFsMh0P04kaUXeHKhXRfiU7K2FqBshR1UlnWe7iHLkq2p9rrGjxQc7ff0w-Uc0f-8PWg36Y2Od7s65493iVQwnI13egqMaSvgB1s8_dgm08noEjhr8C5m1aKmr5oipWEPNi-SBV2VNuiCLR1IEPuXq0tOwwZfv31t34KPO-2H2bbaWmzGJy9mMOGqoNrbXyGiUZoyeHRELaNtm1GilyQ" }
Possible Errors:
  • OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by getServerJWK

获取JSON Web密钥(JWK)URI

获取OAuth2服务器的公共JSON Web密钥(JWK)URI。
客户端应用程序需要验证ID令牌,自包含访问令牌和其他已发布的对象。

Typical Successful Response:

								
									
{ "jwks_uris":[{ "jwks_uri":"https://www.googleapis.com/oauth2/v3/certs" }] }
Possible Errors:
  • OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by getOAuth2ServerJWKsURIs

获取当前通话的通话上下文

获取当前通话的通话上下文。

身份验证是强制性的

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Required Roles:
  • CanGetCallContext - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in OBPv4.0.0 by getCallContext

获取连接器状态(环回)

该端点调用连接器以检查后端传输(例如Kafka)是否可以到达。

当前,这仅适用于基于Kafka的连接器。

对于基于Kafka的连接器,此端点将消息写入Kafka并再次读取。

将来,此端点还可能返回有关数据库连接等的信息。

身份验证是强制性的

Typical Successful Response:

								
									
{ "connector_version":"kafka_vSept2018", "git_commit":"f0acd4be14cdcb94be3433ec95c1ad65228812a0", "duration_time":"10 ms" }
Possible Errors:
  • OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by getObpConnectorLoopback

获取适配器信息

获取有关适配器的基本信息。

身份验证是强制性的

Typical Successful Response:

								
									
{ "name":"String", "version":"String", "git_commit":"String", "date":"2013-01-21T23:08:00Z" }
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by getAdapterInfo

获取速率限制信息

获取有关此OBP实例上的速率限制设置的信息,例如:

速率限制已启用并处于活动状态吗?
后端用于跟踪API调用(例如REDIS)。

身份验证是强制性的

Typical Successful Response:

								
									
{ "enabled":true, "technology":"REDIS", "service_available":true, "is_active":true }
Possible Errors:
  • OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by getRateLimitingInfo

获取银行的适配器信息

获取有关代表该银行进行监听的适配器的基本信息。

身份验证是强制性的

Typical Successful Response:

								
									
{ "name":"String", "version":"String", "git_commit":"String", "date":"2013-01-21T23:08:00Z" }
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in OBPv3.0.0 by getAdapterInfoForBank