How do i configure a Web Proxy Service? | Aquro Help Center

To edit a Web Proxy Service, first navigate to the service by following these steps:

  1. Open up the app in Aquro App Studio
  2. Navigate to the Development pane
  3. Expand the Backend services node in the left tree view
  4. Expand the Web Proxy Service node
  5. Click on the name of the web proxy you like to edit

Configuring a Web Proxy Service is done in three different sections: GENERAL, ARGUMENTS and DATA.

GENERAL
Under the GENERAL tab the general settings of the Web Proxy service is configured. You will find some different settings:

ARGUMENTS
Under the ARGUMENTS tab you may configure arguments that will be sent with your request. If the service is set to do a GET request the parameters will be added to the QueryString and if the services is set to do a POST request the parameters will be added to the post data.

Each argument is set by defining the Key and the Value of the argument. If the Value field is left empty this argument may be set when requesting the service.

DATA
Under the DATA tab you may configure how data should be extracted from the response from the server and how it will be returned in the response from the Web Proxy service.

The configuration of data extraction is done in two steps:

  1. Make a request to the remote host and parse the response to determin the schema of the data.
  2. Selecting sections of the schema that will be extracted from the response.
  3. Mapping which field from the selected section that will be mapped to which property of your data model

To get started with configuring the data extraction begin with generating a schema for the response by following these steps:

  1. Goto the DATA tab
  2. Click on the GENERATE SCHEMA button
  3. Verify that the URL and the arguments listed in the popup window is correct.
  4. When ready click the GENERATE SCHEMA button

A request will now be done to the specified URL and the response will be parsed and a schema will be generated - if possible.

Please note that only requests that results in a JSON or a XML document will be parsed. All other requests will fail and you will be unable to extract data from the response.

Once a schema is generated you are ready to configure the data that should be extracted. This is done by following these steps:

  1. Click on a section in the schema that you like to extract
  2. Click on the EXTRACT button
  3. Set a name of the extracted data and select a data model that will be used when extracting the data
  4. Click the ADD button

The last step is to map the fields from the schema into the properties of your data model. To map a field from the schema into a property in your data model follow these steps:

  1. Locate the property you like to map from your schema
  2. Drag the property from your schema (the list to the left) and drop it on a property in your DataModel (the list to the right). A line will be drawn that indicates that the mapping have been done.

When the sections you like to extract have been mapped you are ready to use your Web Proxy Service.

You may do this by using the Visual Coding Manager Cloud.Proxy.Execute or by using the API directly by calling the /Proxy/Execute api.