Managing Infrastructure

The integration namespace infrastructure consists of one section: API dependencies.

Create API Dependencies

API dependencies are the specification of the external APIs. When created, you are able to easily call the operation provided in the external API.

API dependencies are created using the following master data:


Property	Description
Name	This is the name of the API dependency. It is unique within a namespace. Please note that only the characters A-z (without special characters), digits and the special character "_" are permitted for naming API dependencies! Furthermore, names may not begin with a digit and the first character must be lowercase. The local identifier can not be changed after creation. This field is mandatory.
API specification	This is the specification of the API that is being integrated. The expected formats are JSON and YAML. The uploaded specification is later shown on the instance page of the API dependency. This field is optional.
DEV binding	DEV binding are optional specifications created per API dependency. This means that the DEV binding only lives as a part of the API dependency and shares its life-cycle. It is assigned a unique name internally and will not receive an identifier within Solution Designer. DEV bindings are created in Solution Designer together as a part of the corresponding API dependency. Externalizing those binding information must be done in Configuration Management. API bindings specified there will always overwrite the ones specified in Solution Designer and can differ across stages and/or Solution Envoys. An API binding always consists of a JSON string that may also include an URL (as specified in OpenAPI 3). This field is optional. Attention: If the JSON Web Token (JWT) used in your solution should be forwarded to call the API dependency `k5_propagate_security_token: true` must be included in the DEV binding.
Local lookup	By using this option no additional binding information is necessary. The URL of the dependency will be changed dynamically depending on the deployment namespace. Also the JSON Web Token (JWT) will be forwarded and used to call the API dependency. This field is optional. Attention: This option should only be used for API dependencies that have been designed and implemented with Financial Services Workbench and are deployed within the same projects/namespaces

Add a custom CA certificate in API binding

To support custom certificates to call an external API, we recommend to specify the CA cert accordingly in the binding of the API:

{"ca_cert": "your custom certificate" }

Attention: Please notice that SWAGGER specifications will always be converted to a OpenAPI 3 specification while uploading the file. In all cases the file will have the suffix .yaml.

Edit API Dependencies

You edit the master data of an API dependency by using the Information capability, navigating to the section Master Data and using the Edit Master Data capability or by using the inline and header Edit capability. For a description of the master data, see the section Create API dependencies. The type and the local identifier cannot be changed. When editing the master data of an API dependency, you can overwrite the values for label, short label and notes. The overwritten values are lost as soon as the editing action has been completed.

Delete an API Dependency

You can delete the API dependency by using the inline Delete capability. Alternatively, you can use the Information capability to access the Details view and there you can use the Delete capability.

You will need to confirm the action before the selected response is permanently deleted.