right logo image
right logo image
Log on

API Explorer

Log off

v3.1.0 (249 APIs)

API Host: https://api.ttk.com.mk
Bank
Accounts
Views
Counterparties
Transactions

Get API Configuration

Returns information about:

  • The default bank_id
  • Akka configuration
  • Elastic Search configuration
  • Cached functions

Authentication is Mandatory

JSON response body fields:

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.
Connector Methods:
Implemented in OBPv3.1.0 by config, operation_id: OBPv3.1.0-config

Get API Info (root)

Returns information about:

  • API version
  • Hosted by information
  • Git Commit

Authentication is Optional

JSON response body fields:

Typical Successful Response:

								
									
{
  "version":"String",
  "version_status":"String",
  "git_commit":"String",
  "connector":"String",
  "hosted_by":{
    "organisation":"String",
    "email":"String",
    "phone":"String",
    "organisation_website":"String"
  }
}
Possible Errors:
  • OBP-50000: Unknown Error.
  • no connector set
Connector Methods:
Implemented in OBPv1.2.1 by root, operation_id: OBPv1.2.1-root

Get Adapter Info

Get basic information about the Adapter.

Authentication is Optional

JSON response body fields:

  • date: 2020-01-27

  • git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28

Typical Successful Response:

								
									
{
  "name":"String",
  "version":"String",
  "git_commit":"String",
  "date":"2013-01-21T23:08:00Z"
}
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.1.0 by getAdapterInfo, operation_id: OBPv3.1.0-getAdapterInfo

Get Adapter Info for a bank

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

Authentication is Optional

URL Parameters:

JSON response body fields:

  • date: 2020-01-27

  • git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28

Typical Successful Response:

								
									
{
  "name":"String",
  "version":"String",
  "git_commit":"String",
  "date":"2013-01-21T23:08:00Z"
}
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.0.0 by getAdapterInfoForBank, operation_id: OBPv3.0.0-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

JSON response body fields:

  • git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28
Typical Successful Response:

								
									
{
  "connector_version":"kafka_vSept2018",
  "git_commit":"f0acd4be14cdcb94be3433ec95c1ad65228812a0",
  "duration_time":"10 ms"
}
Possible Errors:
  • OBP-50000: Unknown Error.
  • OBP-20001: User not logged in. Authentication is required!
Connector Methods:
Implemented in OBPv3.1.0 by getObpConnectorLoopback, operation_id: OBPv3.1.0-getObpConnectorLoopback

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.

Authentication is Optional

JSON response body fields:

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.
Connector Methods:
Implemented in OBPv3.1.0 by getServerJWK, operation_id: OBPv3.1.0-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.

Authentication is Optional

JSON response body fields:

Typical Successful Response:

								
									
{
  "jwks_uris":[{
    "jwks_uri":"https://www.googleapis.com/oauth2/v3/certs"
  }]
}
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.1.0 by getOAuth2ServerJWKsURIs, operation_id: OBPv3.1.0-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

JSON response body fields:

Typical Successful Response:

								
									
{
  "enabled":true,
  "technology":"REDIS",
  "service_available":true,
  "is_active":true
}
Possible Errors:
  • OBP-50000: Unknown Error.
  • OBP-20001: User not logged in. Authentication is required!
Connector Methods:
Implemented in OBPv3.1.0 by getRateLimitingInfo, operation_id: OBPv3.1.0-getRateLimitingInfo