right logo image
right logo image
Log on
⯆

API Explorer

Log off

v5.1.0 (267 APIs)

API Host: https://api3.openbankproject.com
Bank
Accounts
Views
Counterparties
Transactions

删除方法

删除METHOD_ROUTING_ID指定的MethodRouting。

身份验证是强制性的

Typical Successful Response: 

								
									
{
  "jsonString":"{}"
}
Required Roles:
  • CanDeleteMethodRouting - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by deleteMethodRouting, operation_id: OBPv3.1.0-deleteMethodRouting Tags: Method-Routing, API, New-Style,

更新方法

更新MethodRouting。

身份验证是强制性的

领域解释：

  • method_name是必需的字符串值
  • connector_name是必需的字符串值
  • is_bank_id_exact_match是必需的布尔值，如果bank_id_pattern是确切的bank_id值，则此值为true；否则，此值为true。如果bank_id_pattern为null或正则表达式，则该值为false
  • bank_id_pattern是可选的字符串值，可以为null，确切的bank_id或正则表达式
  • 参数是键值对的可选数组。您可以为此方法设置一些参数
    注意：

  • 如果bank_id_pattern是正则表达式，则需要对特殊字符进行转义，例如：bank_id_pattern =“ some-id_pattern_ \ d +”

Typical Successful Response: 

								
									
{
  "is_bank_id_exact_match":true,
  "method_name":"getBank",
  "connector_name":"rest_vMar2019",
  "method_routing_id":"this-method-routing-Id",
  "bank_id_pattern":"some_bankId",
  "parameters":[{
    "key":"url",
    "value":"http://mydomain.com/xxx"
  }]
}
Required Roles:
  • CanUpdateMethodRouting - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by updateMethodRouting, operation_id: OBPv3.1.0-updateMethodRouting Tags: Method-Routing, API, New-Style,

添加方法

添加一个MethodRouting。

身份验证是强制性的

领域解释：

  • method_name是必需的字符串值
  • connector_name是必需的字符串值
  • is_bank_id_exact_match是必需的布尔值，如果bank_id_pattern是确切的bank_id值，则此值为true；否则，此值为true。如果bank_id_pattern为null或正则表达式，则该值为false
  • bank_id_pattern是可选的字符串值，可以为null，确切的bank_id或正则表达式
  • 参数是键值对的可选数组。您可以为此方法设置一些参数

注意：

  • 如果bank_id_pattern是正则表达式，则需要对特殊字符进行转义，例如：bank_id_pattern =“ some-id_pattern_ \ d +”
Typical Successful Response: 

								
									
{
  "is_bank_id_exact_match":false,
  "method_name":"getBank",
  "connector_name":"rest_vMar2019",
  "method_routing_id":"this-method-routing-Id",
  "bank_id_pattern":"some_bankId_.*",
  "parameters":[{
    "key":"url",
    "value":"http://mydomain.com/xxx"
  }]
}
Required Roles:
  • CanCreateMethodRouting - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by createMethodRouting, operation_id: OBPv3.1.0-createMethodRouting Tags: Method-Routing, API, New-Style,

获取MethodRoutings

获取所有MethodRoutings。

查询网址参数：

  • method_name：使用method_name进行过滤
  • active：如果active = true，它将显示所有webui_道具。即使已设置，我们也会重新运行所有默认的webui_ props

例如：
http：// localhost：8080 / obp / v3.1.0 / management / method_routings？active = true
http：// localhost：8080 / obp / v3.1.0 / management / method_routings？method_name = getBank

Typical Successful Response: 

								
									
{
  "method_routings":[{
    "is_bank_id_exact_match":false,
    "method_name":"getBanks",
    "connector_name":"rest_vMar2019",
    "method_routing_id":"method-routing-id",
    "bank_id_pattern":"some_bank_.*",
    "parameters":[{
      "key":"url",
      "value":"http://mydomain.com/xxx"
    }]
  }]
}
Required Roles:
  • CanGetMethodRoutings - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getMethodRoutings, operation_id: OBPv3.1.0-getMethodRoutings Tags: Method-Routing, API, New-Style,