Register
API Explorer 936 endpoints
https://obp-api-sandbox.nmbbank.co.tz

Get Connector Method Names

GET /obp/v7.0.0/system/connector-method-names

OBPv6.0.0-getConnectorMethodNames Roles: CanGetSystemConnectorMethodNames Connector-MethodSystemMethod-RoutingAPI

Get the list of all available connector method names.

These are the method names that can be used in Method Routing configuration.

Data Source

The data comes from scanning the actual Scala connector code at runtime using reflection, NOT from a database or configuration file.

The endpoint:

  1. Reads the connector name from props (e.g., connector=mapped)
  2. Gets the connector instance (e.g., LocalMappedConnector, KafkaConnector, StarConnector)
  3. Uses Scala reflection to scan all public methods that override the base Connector trait
  4. Filters for valid connector methods (public, has parameters, overrides base trait)
  5. Returns the method names as a sorted list

Which Connector?

Depends on your connector property:

  • connector=mapped → Returns methods from LocalMappedConnector
  • connector=kafka_vSept2018 → Returns methods from KafkaConnector
  • connector=star → Returns methods from StarConnector
  • connector=rest_vMar2019 → Returns methods from RestConnector

When Does It Change?

The list only changes when:

  • Code is deployed with new/modified connector methods
  • The connector property is changed to point to a different connector

Performance

This endpoint uses caching (default: 1 hour) because Scala reflection is expensive. Configure via: getConnectorMethodNames.cache.ttl.seconds=3600

Use Case

Use this endpoint to discover which connector methods are available when configuring Method Routing. These method names are different from API endpoint operation IDs (which you get from /resource-docs).

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

CanGetSystemConnectorMethodNames entitlement is required.

JSON response body fields (1)
connector_method_names
connector_method_names
Example success response 
{
  "connector_method_names": [
    "getBank",
    "getBanks",
    "getUser",
    "getAccount",
    "makePayment",
    "getTransactions"
  ]
}
Possible errors (3)
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Implemented by OBPv6.0.0 getConnectorMethodNames Originally /obp/v6.0.0/system/connector-method-names