Skip to content

Latest commit

 

History

History
68 lines (48 loc) · 2.88 KB

SandboxApi.md

File metadata and controls

68 lines (48 loc) · 2.88 KB
Raw

obp_python.SandboxApi

All URIs are relative to http://test.openbankproject.com

Method HTTP request Description
o_bpv2_1_0_sandbox_data_import POST /obp/v5.0.0/sandbox/data-import Create sandbox

o_bpv2_1_0_sandbox_data_import

SuccessMessage o_bpv2_1_0_sandbox_data_import(body)

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

Example

from __future__ import print_function
import time
import obp_python
from obp_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: directLogin
configuration = obp_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# Configure API key authorization: gatewayLogin
configuration = obp_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = obp_python.SandboxApi(obp_python.ApiClient(configuration))
body = obp_python.SandboxDataImport() # SandboxDataImport | SandboxDataImport object that needs to be added.

try:
    # Create sandbox
    api_response = api_instance.o_bpv2_1_0_sandbox_data_import(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SandboxApi->o_bpv2_1_0_sandbox_data_import: %s\n" % e)

Parameters

Name Type Description Notes
body SandboxDataImport SandboxDataImport object that needs to be added.

Return type

SuccessMessage

Authorization

directLogin, gatewayLogin

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]