API Bindings

API-bindings are externalized specifications created per API dependency and can be managed via configuration management under configuration-controller as solution specific configuration

To specify the API-bindings follow the steps below:

  1. Under configuration-management, open the configuration-controller
  2. Use POST at /api/cfg/v1/runtimes/{runtimeName}/solutions/{solutionAcronym}/configurations/{configurationName} method to Create an API-binding

The Request Parameters needed are the following:

Parameter TYPE Description
configurationName path parameter (String) The name of the configuration, must be namespace acronym of the integration namespace + API-dependency name in Solution Designer (e.g. acr-example)
runtimeName path parameter (String) The name of the specific Solution Envoy, 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 (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 a API Dependency which also has been developed with Financial Services Workbench
    runtimeName            cpd-runtime-test
                                    solutionAcronym        calling
                                    configuratioName       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: Every change in the API binding will be applied for the solution with a new deployment.