Configuring Integration Server Instance for API Implementation

Edit online

To implement an API to Integration Server, you must provide the details of the Integration Server instances in webMethods API Gateway.

To configure an Integration Server instance

  1. Expand the menu options icon menu_options, in the title bar, and select Administration.
  2. Click External accounts.
  3. Click Integration Servers.
    The list of configured Integration Server instances appears.
  4. Click Add new Integration Server.
    The options to add new Integration Server details appear.
  5. Provide the following details:
    Field Description
    Name Name for the Integration Server instance being added.
    Description Description for the configuration.
    Integration Server URL URL of the Integration Server.
    User name User credentials required to access the Integration Server instance.
    Password Password required to access the Integration Server instance.
    Keystore alias The text identifier for the Integration Server keystore file. The keystore contains the private keys and certificates (including the associated public keys) of Integration Server.
    Key alias The alias for a specific key in the specified keystore.
    Package name Package name of the Integration Server instance in which the API must be implemented.
    Folder name Folder name of the Integration Server instance in which the API must be implemented.
    configure_IS
  6. Select the following based on the API type, to perform the corresponding action.
    Task selection Description
    REST API

    Import Swagger Based on Tags. Select the Import Swagger Based on Tags check box to group the operations under a REST V2 resource based on the tags.

    If you do not select this option, the operations are grouped by path.

    By default, the check box is selected.

    SOAP API

    Content model compliance. Select one of the following to indicate how strictly Integration Server enforces content model compliance when creating Integration Server document types from the XML Schema definition in the WSDL document.

    • Strict. Generate the Integration Server document type only if Integration Server can represent the content models defined in the XML Schema definition correctly. Document type generation fails if Integration Server cannot accurately represent the content models in the source XML Schema definition.
    • Lax. When you select lax compliance, Integration Server will generate the Integration Server document type even if the content models in the XML schema definition cannot be represented correctly.
    • None. Generate an Integration Server document type that does not necessarily represent or maintain the content models in the source XML Schema definition.

    Enable MTOM streaming for elements of type base64Binary. Select the Enable MTOM streaming for elements of type base64Binary check box if you want elements declared to be of type base64Binary in the WSDL or schema to be enabled for streaming of MTOM attachments.

    Enforce WS-I Basic Profile 1.1 compliance. Select the Enforce WS-I Basic Profile 1.1 compliance check box, if you want to validate all the WSD objects and properties against the WS-I requirements before creating the WSD.

    Validate schema using Xerces. Select the Validate schema using Xerces check box, if you want Integration Server to use the Xerces Java parser to validate any schema elements in the WSDL document or any referenced XML Schema definitions.

    GRAPHQL API

    Skip custom scalar types. Select the Skip custom scalar types check box, if you want omit the GraphQL API's custom scalar data types.

  7. To validate the connectivity of the specified Integration Server instance, click Test.
    The connection with the given server is tested and a success message appears.
  8. Click Add.
    The server details are saved.