API Proxy Adapter

With Quantum Fabric API Proxy (pass-through proxy) integration service, you can forward the request and response without intermediate transformation (without affecting the actual request and response.)

For example:

If an organization has an existing set of APIs already exposed and wants to secure and throttle the APIs, it can use the API Proxy adapter. By enabling API Proxy, the input (body and headers) of a client's input request is forwarded to the back end and the output response from the back end is forwarded to the device with no changes in the input request and output response.

If your APIs are documented using an Open API Specification file (Swagger file), you can create a new API Proxy service and import the OAS(Swagger) file to automatically create Quantum Fabric Operations.

You can configure API Proxy integration service for the following endpoints:

  • XML

  • JSON

Configure API Proxy Endpoint Adapter

To configure API Proxy service in the Integration Service Definition tab, follow these steps:

  1. In the Name field, provide a unique name for your service.
  2. From the Service Type list, select API Proxy.
  3. Provide the following details in the API Proxy service definition:
  4. Field Description
    Base URL Configuration
    • Base URL - Type the URL (provide the format and explain the URL parameters)
    • Upload Open API file - Click Upload File, the system allows you to upload an OAS (Swagger) file. Navigate to the swagger file from your local system, and click Open. The system uploads the selected swagger file. The operations for your API proxy service are created based on the resources defined in OAS (Swagger) file.
    Web Service Authentication

    Web Service Authentication Select one of the following modes:

    • None- Select this option if you do not want to provide any authentication for the service.
    • Basic- Provide User ID and Password if the external Web service requires a form or basic authentication.
    • NTLM- Your service follows the NT LAN Manager authentication process. You are required to provide the User ID, Password, NTLM Host, and NTLM Domain.
    Identity Service for Backend Token Select the Identity service associated with your app if this service needs backend token like access_token from that Identity service to access the backend server.

    NOTE: For more information on Externalizing Identity Services, refer to Replace the Identity Service references in a Fabric app.


  5. NOTE: All options in the Advanced section are optional.

  6. In the Description field, provide a suitable description for the service.
  7. To enable the proxy, select the Use proxy from settings check box. By default, the check box is cleared. The Use proxy from settings check box dims when no proxy is configured under the Settings > Proxy.

  8. Click Save to save your service definition.

Create Operations for API Proxy

The Operations List tab appears only after the service definition is saved.

NOTE: Click Operations List tab > Configure Operation. The Configured Operations list appears.

IMPORTANT: If you have imported an OAS (Swagger) file, the operations for your API proxy service are created automatically from that OAS (Swagger) file. The endpoint URL is also auto-generated based on the Swagger file. The auto-generated operations for a proxy service will not have request/response parameters.

  1. Click SAVE & ADD OPERATION in your service definition page to save your service definition and display the NewOperation tab for adding operations.
                        OR
    Click Add Operation to add a new operation or from the tree in the left pane, click Add > Add New Operation.

  1. To create an operation, provide the following details:
  2. Field Description
    Name Enter a unique name for your operation.
    Operation Security Level

    It specifies how a client must authenticate to invoke this operation.

    Front End HTTP Method

    Select a HTTP method that you want to invoke on the integration server. By default, the field is set to Post method.

    NOTE: The front-end HTTP methods are used for all non-SDK clients such as API Management users.
    Invoking a service from an SDK will continue to use the POST method for operations.

    NOTE: From SP3 onwards, the Front End HTTP Method is called as Resource Method. You can configure the Resource Method in the Advanced> Front End API section.

    Target HTTP Method Select a HTTP method that you want to invoke on the back-end service from integration server.
    Operation Path

    Modify the path if required.

    NOTE: If you provide incorrect Salesforce endpoint details, the Object list will contain only _Login object.

    Base URL and Target URL

    The Target URL field is prepopulated with the URL that you provided at the Base URL field. You can add the suffix, if required.

    For example, to the base URL, you can add suffix such as /latest  or /sports to get latest news or sports news:

    • http://feeds.foxnews.com/foxnews/latest
    • http://feeds.foxnews.com/foxnews/sports

  3. NOTE: All options in the Advanced section are optional.

  4. Click Save to save the operation.

Limitations for API Proxy Adapter

  • API Proxy service operations and operations for which pass-through (inputs, headers, and outputs) is enabled cannot be used in orchestration services.

    For example, when you create an integration service with an API Proxy type or the operations of XML, SOAP, or JSON endpoints with pass-through enabled, the system does not show the services and operations while configuring orchestration operations.
  • Using the MBaaS Client SDK with API Proxy integration service is not supported.

How to Enable Pass-through Proxy for Operations

You can also configure the following pass-through proxy flags in operations for adapters such as XML, SOAP, and JSON:

  • Under the Request Input> Body tab, select the Enable pass-through input body check box to forward the body of a client's request to the back end.
  • Under the Request Input>Header tab, select the Enable pass-through input header check box to forward headers of a client's request to the backend.
  • Under the Response Output tab, select the Enable pass-through output body check box to forward the response from the backend to a client.