EasyMorph Help

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
===== Web Location =====

Specifies a web location that can later be used for sending web requests. The action supports 6 authentication modes:

  * No authentication
  * Basic HTTP authentication
  * HTTP Digest authentication
  * Windows identity (a.k.a. Windows integrated)
  * OAuth2
  * API key

Note that implementation of OAuth2 by some web services may require frequent renewals of refresh tokens. Since EasyMorph connectors are immutable (mutable connectors are coming in 2021) a "Web location" connector is only valid until the 1st refresh token expires, and will require re-authentication after that.

=== Tab Connection ===

^ Setting ^ Description ^
| Base URL  | A URL that must include protocol schema (e.g. %%"https://"%%) and host (e.g. "www.googleapis.com"). May optionally include port and URL path.  |
| Authentication  | One of the authentication modes described above. |

OAuth2 settings:

^ Setting ^ Description ^
| Authorization URL  | Defined by the web service you're connecting to. E.g. "https://accounts.google.com/o/oauth2/v2/auth".  |
| Token URL  | Defined by the web service you're connecting to. E.g. "https://oauth2.googleapis.com/token".  |
| Redirect URI  | Redirect to a (local or not) URI after authorization is performed. If you're not sure what this is try localhost with a random port, e.g. "http://localhost:12456".  |
| Client ID  | The ID of your OAuth client configured in the target web service.  |
| Client secret  | Optional secret that could be configured in your OAuth client specified above.  |
| Don't use PKCE  | [[https://oauth.net/2/pkce/|PKCE]] is a popular additional security measure frequently used by web services. May not be supported by the web service you are connecting to.  |
| Permission scopes | A list of permission scopes as they are defined by the target web service. See the web-service documentation on how the scopes are identified. Can be something like "https://www.googleapis.com/auth/analytics.readonly" or "Dataset.ReadWrite.All"  |
| Parameters  | Optional additional connection parameters specified as key-value pairs as specified by the target web service.  |

=== Tab Options ===

^ Setting ^ Description ^
| Request timeout  | Time in seconds after which a web request will fail automatically if it's not completed by then. |
| Use throttling | Throttling settings that limit the number of requests sent to the target web service. Specified per connector, but used on a per-project basis.  |
| Handle HTTP 429 automatically  | If the target web service responds with [[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429|HTTP 429]] (too many requests) then EasyMorph can automatically retry sending web request after the delay specified in the server's response.  |
| Don't send User-Agent automatically  |By default, EasyMorph sends the User-Agent HTTP header (e.g. "User-Agent: EasyMorph 5.4" - note that only the first two numbers of the current EasyMorph version are sent).  Checking this option prevents EasyMorph from including this header.|  

=== Tab Proxy ===
Configure proxy settings, if required. Consult your network administrator for proxy settings, if necessary.

=== Tab URL parameters ===
The URL parameters specified in this tab will be automatically appended to all web requests sent using the connector. This setting is most commonly used to specify API keys that must be included as URL parameters.

If a "Web request" action also specifies the same URL parameter name but with a different value, the actions setting will take precedence over the connector's setting.

=== Tab Headers ===
The request headers specified in this tab will be automatically appended to all web requests sent using the connector. This setting is most commonly used to specify API keys that must be included as request headers.

If a "Web request" action also specifies the same header but with a different value, the actions setting will take precedence over the connector's setting.

=== Cookie container ===
When project execution starts the "Web location" connector creates a temporary cookie container that only exists during one project execution and is discarded when execution stops. The container automatically stores cookies set by HTTP responses and automatically appends them to outgoing web requests. During iterations or call, the cookie container is seamlessly passed to the called module/project thus enabling cookie-based session management.

** See also **

  * [[transformations:webrequest|Action "Web Request"]]
  * [[transformations:iteratewebrequest|Action "Iterate Web Request"]]