API Explorer

Open Bank Project
Login

OBP v4.0.0 filtered by tag: API, API-Role, API-Metrics, API-Documentation (34 APIs)

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

Bank

Accounts

Views

Counterparties

Transactions

Get API Configuration

Returns information about:

  • The default bank_id
  • Akka configuration
  • Elastic Search configuration
  • Cached functions
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"]
  }
}
Headers:
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

Get API Info (root)

Returns information about:

  • API version
  • Hosted by information
  • Hosted at information
  • Energy source information
  • Git Commit
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/"
  }
}
Headers:
Possible Errors:
  • OBP-50000: Unknown Error.
  • no connector set
Implemented in OBPv4.0.0 by root

Get Adapter Info

Get basic information about the Adapter.

Authentication is Mandatory

Typical Successful Response:

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

Get Adapter Info for a bank

Get basic information about the Adapter listening on behalf of this bank.

Authentication is Mandatory

Typical Successful Response:

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

Get Connector Status (Loopback)

This endpoint makes a call to the Connector to check the backend transport (e.g. Kafka) is reachable.

Currently this is only implemented for Kafka based connectors.

For Kafka based connectors, this endpoint writes a message to Kafka and reads it again.

In the future, this endpoint may also return information about database connections etc.

Authentication is Mandatory

Typical Successful Response:

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

Get JSON Web Key (JWK)

Get the server's public JSON Web Key (JWK) set and certificate chain.
It is required by client applications to validate ID tokens, self-contained access tokens and other issued objects.

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"
}
Headers:
Possible Errors:
  • OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by getServerJWK

Get JSON Web Key (JWK) URIs

Get the OAuth2 server's public JSON Web Key (JWK) URIs.
It is required by client applications to validate ID tokens, self-contained access tokens and other issued objects.

Typical Successful Response:

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

Get Rate Limiting Info

Get information about the Rate Limiting setup on this OBP Instance such as:

Is rate limiting enabled and active?
What backend is used to keep track of the API calls (e.g. REDIS).

Authentication is Mandatory

Typical Successful Response:

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

Get the Call Context of a current call

Get the Call Context of the current call.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "jsonString":"{}"
}
Headers:
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

Enable or Disable Consumers

Enable/Disable a Consumer specified by CONSUMER_ID.

Typical Successful Response:

								
									
{
  "enabled":false
}
Headers:
Required Roles:
  • CanEnableConsumers - Please login to request this Role
  • CanDisableConsumers - 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 OBPv2.1.0 by enableDisableConsumers

Get Consumer

Get the Consumer specified by CONSUMER_ID.

Typical Successful Response:

								
									
{
  "consumer_id":1213,
  "app_name":"SOFI",
  "app_type":"Web",
  "description":"Account Management",
  "developer_email":"eveline@example.com",
  "redirect_url":"www.openbankproject.com",
  "created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "created_by_user":{
    "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "email":"eveline@example.com",
    "provider_id":"Chris",
    "provider":"http://127.0.0.1:8080",
    "username":"felixsmith"
  },
  "enabled":true,
  "created":"2017-09-19T00:00:00Z"
}
Headers:
Required Roles:
  • CanGetConsumers - 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-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.
  • OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by getConsumer

Get Consumers

Get the all Consumers.

Typical Successful Response:

								
									
{
  "consumers":[{
    "consumer_id":"8e716299-4668-4efd-976a-67f57a9984ec",
    "app_name":"SOFI",
    "app_type":"Web",
    "description":"Account Management",
    "developer_email":"eveline@example.com",
    "redirect_url":"www.openbankproject.com",
    "created_by_user":{
      "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
      "email":"eveline@example.com",
      "provider_id":"Chris",
      "provider":"http://127.0.0.1:8080",
      "username":"felixsmith"
    },
    "enabled":true,
    "created":"2017-09-19T00:00:00Z"
  }]
}
Headers:
Required Roles:
  • CanGetConsumers - 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 getConsumers

Get Consumers (logged in User)

Get the Consumers for logged in User.

Typical Successful Response:

								
									
{
  "consumers":[{
    "consumer_id":"8e716299-4668-4efd-976a-67f57a9984ec",
    "app_name":"SOFI",
    "app_type":"Web",
    "description":"Account Management",
    "developer_email":"eveline@example.com",
    "redirect_url":"www.openbankproject.com",
    "created_by_user":{
      "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
      "email":"eveline@example.com",
      "provider_id":"Chris",
      "provider":"http://127.0.0.1:8080",
      "username":"felixsmith"
    },
    "enabled":true,
    "created":"2017-09-19T00:00:00Z"
  }]
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by getConsumersForCurrentUser

Update Consumer RedirectUrl

Update an existing redirectUrl for a Consumer specified by CONSUMER_ID.

CONSUMER_ID can be obtained after you register the application.

Or use the endpoint 'Get Consumers' to get it

Typical Successful Response:

								
									
{
  "consumer_id":1213,
  "app_name":"SOFI",
  "app_type":"Web",
  "description":"Account Management",
  "developer_email":"eveline@example.com",
  "redirect_url":"www.openbankproject.com",
  "created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "created_by_user":{
    "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "email":"eveline@example.com",
    "provider_id":"Chris",
    "provider":"http://127.0.0.1:8080",
    "username":"felixsmith"
  },
  "enabled":true,
  "created":"2017-09-19T00:00:00Z"
}
Headers:
Required Roles:
  • CanUpdateConsumerRedirectUrl - 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 OBPv2.1.0 by updateConsumerRedirectUrl

Get Message Docs

These message docs provide example messages sent by OBP to the (Kafka) message queue for processing by the Core Banking / Payment system Adapter - together with an example expected response and possible error codes.
Integrators can use these messages to build Adapters that provide core banking services to OBP.

Note: API Explorer provides a Message Docs page where these messages are displayed.

CONNECTOR:kafka_vMar2017 , kafka_vJune2017, kafka_vSept2018 ...

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
    }
  }]
}
Headers:
Possible Errors:
  • OBP-50000: Unknown Error.
Implemented in OBPv2.2.0 by getMessageDocs

Get Message Docs Swagger

This endpoint provides example message docs in swagger format.
It is only relavent for REST Connectors.

This endpoint can be used by the developer building a REST Adapter that connects to the Core Banking System (CBS).
That is, the Adapter developer can use the Swagger surfaced here to build the REST APIs that the OBP REST connector will call to consume CBS services.

i.e.:

OBP API (Core OBP API code) -> OBP REST Connector (OBP REST Connector code) -> OBP REST Adapter (Adapter developer code) -> CBS (Main Frame)

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
    }
  }]
}
Headers:
Possible Errors:
  • OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by getMessageDocsSwagger

Get Resource Docs.

Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.

This is the native data format used to document OBP endpoints. Each endpoint has a Resource Doc (a Scala case class) defined in the source code.

This endpoint is used by OBP API Explorer to display and work with the API documentation.

Most (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)

API_VERSION is the version you want documentation about e.g. v3.0.0

You may filter this endpoint with tags parameter e.g. ?tags=Account,Bank

You may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics

For possible function values, see implemented_by.function in the JSON returned by this endpoint or the OBP source code or the footer of the API Explorer which produces a comma separated list of functions that reflect the server or filtering by API Explorer based on tags etc.

You may filter this endpoint using the 'Catalogs' url parameter e.g. ?core=&psd2=true&obwg=

See the Resource Doc endpoint for more information.

Following are more examples:
https://api.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/obp
https://api.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/obp?psd2=true
https://api.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/obp?tags=Account,Bank
https://api.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/obp?functions=getBanks,bankById
https://api.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/obp?psd2=true&tags=Account,Bank&functions=getBanks,bankById

  • operation_id is concatenation of "v", version and function and should be unique (used for DOM element IDs etc. maybe used to link to source code)
  • version references the version that the API call is defined in.
  • function is the (scala) partial function that implements this endpoint. It is unique per version of the API.
  • request_url is empty for the root call, else the path. It contains the standard prefix (e.g. /obp) and the implemented version (the version where this endpoint was defined) e.g. /obp/v1.2.0/resource
  • specified_url (recommended to use) is empty for the root call, else the path. It contains the standard prefix (e.g. /obp) and the version specified in the call e.g. /obp/v3.1.0/resource. In OBP, endpoints are first made available at the request_url, but the same resource (function call) is often made available under later versions (specified_url). To access the latest version of all endpoints use the latest version available on your OBP instance e.g. /obp/v3.1.0 - To get the original version use the request_url. We recommend to use the specified_url since non semantic improvements are more likely to be applied to later implementations of the call.
  • summary is a short description inline with the swagger terminology.
  • description may contain html markup (generated from markdown on the server).
Typical Successful Response:

								
									
{
  "jsonString":"{}"
}
Headers:
Possible Errors:
  • OBP-50000: Unknown Error.
Implemented in OBPv1.4.0 by getResourceDocsObp

Get Swagger documentation

Returns documentation about the RESTful resources on this server in Swagger format.

API_VERSION is the version you want documentation about e.g. v3.0.0

You may filter this endpoint using the 'tags' url parameter e.g. ?tags=Account,Bank

(All endpoints are given one or more tags which for used in grouping)

You may filter this endpoint using the 'functions' url parameter e.g. ?functions=getBanks,bankById

(Each endpoint is implemented in the OBP Scala code by a 'function')

You may filter this endpoint using the 'Catalogs' url parameter e.g. ?core=&psd2=true&obwg=

See the Resource Doc endpoint for more information.

Following are more examples:
https://api.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger
https://api.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?psd2=true
https://api.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank
https://api.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?functions=getBanks,bankById
https://api.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?psd2=true&tags=Account,Bank&functions=getBanks,bankById

Typical Successful Response:

								
									
{
  "jsonString":"{}"
}
Headers:
Possible Errors:
  • OBP-50000: Unknown Error.
Implemented in OBPv1.4.0 by getResourceDocsSwagger

Create DynamicEntity

Create a DynamicEntity.

Authentication is Mandatory

Create one DynamicEntity, after created success, the corresponding CURD endpoints will be generated automatically

Current support filed types as follow:
[string, number, integer, boolean]

Typical Successful Response:

								
									
{
  "FooBar":{
    "required":["name"],
    "properties":{
      "name":{
        "type":"string",
        "example":"James Brown"
      },
      "number":{
        "type":"integer",
        "example":698761728
      }
    }
  },
  "dynamicEntityId":"dynamic-entity-id"
}
Headers:
Required Roles:
  • CanCreateDynamicEntity - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Implemented in OBPv4.0.0 by createDynamicEntity

Delete DynamicEntity

Delete a DynamicEntity specified by DYNAMIC_ENTITY_ID.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "jsonString":"{}"
}
Headers:
Required Roles:
  • CanDeleteDynamicEntity - 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 OBPv4.0.0 by deleteDynamicEntity

Get DynamicEntities

Get the all DynamicEntities.

Typical Successful Response:

								
									
{
  "dynamic_entities":[{
    "FooBar":{
      "required":["name"],
      "properties":{
        "name":{
          "type":"string",
          "example":"James Brown"
        },
        "number":{
          "type":"integer",
          "example":698761728
        }
      }
    },
    "dynamicEntityId":"dynamic-entity-id"
  }]
}
Headers:
Required Roles:
  • CanGetDynamicEntities - 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 OBPv4.0.0 by getDynamicEntities

Update DynamicEntity

Update a DynamicEntity.

Authentication is Mandatory

Update one DynamicEntity, after update finished, the corresponding CURD endpoints will be changed.

Current support filed types as follow:
[string, number, integer, boolean]

Typical Successful Response:

								
									
{
  "FooBar":{
    "required":["name"],
    "properties":{
      "name":{
        "type":"string",
        "example":"James Brown"
      },
      "number":{
        "type":"integer",
        "example":698761728
      }
    }
  },
  "dynamicEntityId":"dynamic-entity-id"
}
Headers:
Required Roles:
  • CanUpdateDynamicEntity - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Implemented in OBPv4.0.0 by updateDynamicEntity

Add MethodRouting

Add a MethodRouting.

Authentication is Mandatory

Explaination of Fields:

  • method_name is required String value
  • connector_name is required String value
  • is_bank_id_exact_match is required boolean value, if bank_id_pattern is exact bank_id value, this value is true; if bank_id_pattern is null or a regex, this value is false
  • bank_id_pattern is optional String value, it can be null, a exact bank_id or a regex
  • parameters is optional array of key value pairs. You can set some paremeters for this method

note:

  • if bank_id_pattern is regex, special characters need to do escape, for example: 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"
  }]
}
Headers:
Required Roles:
  • CanCreateMethodRouting - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by createMethodRouting

Delete MethodRouting

Delete a MethodRouting specified by METHOD_ROUTING_ID.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "jsonString":"{}"
}
Headers:
Required Roles:
  • CanDeleteMethodRouting - 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 deleteMethodRouting

Get MethodRoutings

Get the all MethodRoutings.

Query url parameters:

  • method_name: filter with method_name
  • active: if active = true, it will show all the webui_ props. Even if they are set yet, we will retrun all the default webui_ props

eg:
https://api.openbankproject.com/obp/v3.1.0/management/method_routings?active=true
https://api.openbankproject.com/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"
    }]
  }]
}
Headers:
Required Roles:
  • CanGetMethodRoutings - 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 getMethodRoutings

Update MethodRouting

Update a MethodRouting.

Authentication is Mandatory

Explaination of Fields:

  • method_name is required String value
  • connector_name is required String value
  • is_bank_id_exact_match is required boolean value, if bank_id_pattern is exact bank_id value, this value is true; if bank_id_pattern is null or a regex, this value is false
  • bank_id_pattern is optional String value, it can be null, a exact bank_id or a regex
  • parameters is optional array of key value pairs. You can set some paremeters for this method
    note:

  • if bank_id_pattern is regex, special characters need to do escape, for example: 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"
  }]
}
Headers:
Required Roles:
  • CanUpdateMethodRouting - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by updateMethodRouting

Get Connector Metrics

Get the all metrics

require CanGetConnectorMetrics role

Filters Part 1.filtering (no wilde cards etc.) parameters to GET /management/connector/metrics

Should be able to filter on the following metrics fields

eg: /management/connector/metrics?from_date=2017-09-19&to_date=2017-09-19&limit=50&offset=2

1 from_date (defaults to one week before current date): eg:from_date=2017-09-19

2 to_date (defaults to current date) eg:to_date=2017-09-19

3 limit (for pagination: defaults to 1000) eg:limit=2000

4 offset (for pagination: zero index, defaults to 0) eg: offset=10

eg: /management/connector/metrics?from_date=2017-09-19&to_date=2017-09-19&limit=100&offset=300

Other filters:

5 connector_name (if null ignore)

6 function_name (if null ignore)

7 correlation_id (if null ignore)

Typical Successful Response:

								
									
{
  "metrics":[{
    "connector_name":"mapper",
    "function_name":"getBanks",
    "correlation_id":"12345",
    "date":"2017-09-19T00:00:00Z",
    "duration":1000
  }]
}
Headers:
Required Roles:
  • CanGetConnectorMetrics - Please login to request this Role
Possible Errors:
  • OBP-10005: Invalid Date Format. Could not convert value to a Date.
  • OBP-50000: Unknown Error.
Implemented in OBPv2.2.0 by getConnectorMetrics

Get Metrics

Get the all metrics

require CanReadMetrics role

Filters Part 1.filtering (no wilde cards etc.) parameters to GET /management/metrics

Should be able to filter on the following metrics fields

eg: /management/metrics?from_date=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z&limit=50&offset=2

1 from_date (defaults to one week before current date): eg:from_date=2017-09-19T02:31:05.000Z

2 to_date (defaults to current date) eg:to_date=2017-09-19T02:31:05.000Z

3 limit (for pagination: defaults to 50) eg:limit=200

4 offset (for pagination: zero index, defaults to 0) eg: offset=10

5 sort_by (defaults to date field) eg: sort_by=date
possible values:
"url",
"date",
"user_name",
"app_name",
"developer_email",
"implemented_by_partial_function",
"implemented_in_version",
"consumer_id",
"verb"

6 direction (defaults to date desc) eg: direction=desc

eg: /management/metrics?from_date=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z&limit=10000&offset=0&anon=false&app_name=TeatApp&implemented_in_version=v2.1.0&verb=POST&user_id=c7b6cb47-cb96-4441-8801-35b57456753a&user_name=susan.uk.29@example.com&consumer_id=78

Other filters:

7 consumer_id (if null ignore)

8 user_id (if null ignore)

9 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.)

10 url (if null ignore), note: can not contain '&'.

11 app_name (if null ignore)

12 implemented_by_partial_function (if null ignore),

13 implemented_in_version (if null ignore)

14 verb (if null ignore)

15 correlation_id (if null ignore)

16 duration (if null ignore) non digit chars will be silently omitted

Typical Successful Response:

								
									
{
  "metrics":[{
    "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "url":"www.openbankproject.com",
    "date":"2017-09-19T00: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
  }]
}
Headers:
Required Roles:
  • CanReadMetrics - 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 OBPv2.1.0 by getMetrics

Search API Metrics via Elasticsearch.

Search the API calls made to this API instance via Elastic Search.

Login is required.

CanSearchMetrics entitlement is required to search metrics data.

parameters:

esType - elasticsearch type

simple query:

q - plain_text_query

df - default field to search

sort - field to sort on

size - number of hits returned, default 10

from - show hits starting from

json query:

source - JSON_query_(URL-escaped)

example usage:

/search/metrics/q=findThis

or:

/search/metrics/source={"query":{"query_string":{"query":"findThis"}}}

Note!!

The whole JSON query string MUST be URL-encoded:

  • For { use %7B
  • For } use %7D
  • For : use %3A
  • For " use %22

etc..

Only q, source and esType are passed to Elastic

Elastic simple query: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-uri-request.html

Elastic JSON query: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html

Typical Successful Response:

								
									
{
  "jsonString":"{}"
}
Headers:
Required Roles:
  • CanSearchMetrics - 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 OBPv2.0.0 by elasticSearchMetrics

Create sandbox

Import bulk data into the sandbox (Authenticated access).

This call can be used to create banks, users, accounts and transactions which are stored in the local RDBMS.

The user needs to have CanCreateSandbox entitlement.

Note: This is a monolithic call. You could also use a combination of endpoints including create bank, create user, create account and create transaction request to create similar data.

An example of an import set of data (json) can be found here
Authentication is Mandatory

Typical Successful Response:

								
									
{
  "success":"Success"
}
Headers:
Required Roles:
  • CanCreateSandbox - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-00002: Data import is disabled for this API instance.
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Implemented in OBPv2.1.0 by sandboxDataImport

Create password reset url

Create password reset url.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "reset_password_url":"https://apisandbox.openbankproject.com/user_mgt/reset_password/QOL1CPNJPCZ4BRMPX3Z01DPOX1HMGU3L"
}
Headers:
Required Roles:
  • CanCreateResetPasswordUrl - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Implemented in OBPv4.0.0 by resetPasswordUrl

Add WebUiProps

Add a WebUiProps.

Authentication is Mandatory

Explaination of Fields:

  • name is required String value
  • value is required String value

The line break and double quotations should do escape, example:


{"name": "webui_some", "value": "this value
have "line break" and double quotations."}

should do escape like this:


{"name": "webui_some", "value": "this value\nhave \"line break\" and double quotations."}

Insert image examples:

// set width=100 and height=50
{"name": "webui_some_pic", "value": "here is a picture <img alt="hello" src="http://somedomain.com/images/pic.png" width="100" height="50" />"}

// only set height=50
{"name": "webui_some_pic", "value": "here is a picture <img alt="hello" src="http://somedomain.com/images/pic.png" width="" height="50" />"}

// only width=20%
{"name": "webui_some_pic", "value": "here is a picture <img alt="hello" src="http://somedomain.com/images/pic.png" width="20%" height="" />"}
Typical Successful Response:

								
									
{
  "name":"webui_api_explorer_url",
  "value":"https://apiexplorer.openbankproject.com",
  "web_ui_props_id":"some-web-ui-props-id"
}
Headers:
Required Roles:
  • CanCreateWebUiProps - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by createWebUiProps

Delete WebUiProps

Delete a WebUiProps specified by WEB_UI_PROPS_ID.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "jsonString":"{}"
}
Headers:
Required Roles:
  • CanDeleteWebUiProps - 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 deleteWebUiProps

Get WebUiProps

Get the all WebUiProps key values, those props key with "webui_" can be stored in DB, this endpoint get all from DB.

url query parameter:
active: It must be a boolean string. and If active = true, it will show
combination of explicit (inserted) + implicit (default) method_routings.

eg:
https://api.openbankproject.com/obp/v3.1.0/management/webui_props
https://api.openbankproject.com/obp/v3.1.0/management/webui_props?active=true

Typical Successful Response:

								
									
{
  "webui_props":[{
    "name":"webui_api_explorer_url",
    "value":"https://apiexplorer.openbankproject.com",
    "web_ui_props_id":"web-ui-props-id"
  }]
}
Headers:
Required Roles:
  • CanGetWebUiProps - 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 getWebUiProps

Get documentation about the selected endpoints as:

Resource Docs JSON

 

Swagger 2 JSON

This list can be used as a basis to limit the available endpoints by editing the API Props:

[config, root, getAdapterInfo, getAdapterInfoForBank, getObpApiLoopback, getServerJWK, getOAuth2ServerJWKsURIs, getRateLimitingInfo, getCallContext, enableDisableConsumers, getConsumer, getConsumers, getConsumersForCurrentUser, updateConsumerRedirectUrl, getMessageDocs, getMessageDocsSwagger, getResourceDocsObp, getResourceDocsSwagger, createDynamicEntity, deleteDynamicEntity, getDynamicEntities, updateDynamicEntity, createMethodRouting, deleteMethodRouting, getMethodRoutings, updateMethodRouting, getConnectorMetrics, getMetrics, elasticSearchMetrics, sandboxDataImport, resetPasswordUrl, createWebUiProps, deleteWebUiProps, getWebUiProps]

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