API Bindings

API-bindings are externalized specifications created per API dependency and can be managed via the Configuration Management under configuration-controller as a solution-specific configuration.

To specify API-bindings follow the steps below:

  1. Visit the Configuration Management and open the configuration-controller
  2. Use the POST operation create solution specific configuration to create a new configuration

The required request parameters are listed below:

Parameter Type Description
configurationName path parameter (String) The name of the configuration - must be the integration namespace's acronym concatenated by a dash with the API-dependency name in Solution Designer (e.g. acr-example)
runtimeName path parameter (String) The name of the specific k5-project, e.g. cpd-runtime-default.
solutionAcronym path parameter (String) Acronym of the specific solution that uses the dependency, e.g. ORDERS.
configurationValue body parameter (JSON) The binding information needed to call the dependency.

If the JSON Web Token (JWT) used in a solution should be forwarded to call the API dependency, k5_propagate_security_token: true must be included in the configuration value (as JSON).

Attention: You might not need a specific API Binding if the named dependency is also developed with IBM Financial Services Workbench and you marked "Local Lookup" while adding the API dependency in your solution.

Examples:

  1. API binding to call an API dependency named "dependency" from within the integration namespace with the acronym "ns" of a solution with the acronym "calling" (which has also been developed with Financial Services Workbench).
    runtimeName            cpd-runtime-test
solutionAcronym        calling
configurationName      ns-dependency
Request body           {"url":"https://cpd-runtime-test.
                         apps.openshift-host.cloud/dependency/api/v1",
                        "k5_propagate_security_token":true}
  2. API binding to call a foreign API dependency (e.g. a ML-Service)
    runtimeName            cpd-runtime-test
solutionAcronym        calling
configuratioName       ns-dependency
Request body           {
                        "url": "https://mlpattern.123.456.789.10.example.io",
                        "user": "userName",
                        "password": "passWord"
                        }
Attention: Any change to the API binding will only be applied to the solutions after a new deployment..