EasyMorph Help

User Tools

Site Tools

You are here: start » connectors » weblocation
connectors:weblocation

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
connectors:weblocation [2024/05/19 16:06] – dmitryconnectors:weblocation [2024/10/29 18:20] (current) – update formatting craigt
Line 1: Line 1:
-===== Web Location ===== +======WEB LOCATION CONNECTOR====== 
 +\\ 
 +=====Description=====
 Specifies a web location that can later be used for sending web requests. The action supports 6 authentication modes: Specifies a web location that can later be used for sending web requests. The action supports 6 authentication modes:
  
Line 11: Line 12:
  
 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. 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 ===+**Name:**  Provide a name for the connector.\\ 
 +**Note:** Provide any notes regarding the connector (optional).\\ 
 +**Documentation…** Will allow you to enter a URL and Label for connector information. (optional)\\
  
 +\\ 
 +=====Connector settings=====
 +
 +==== Connection settings =====
 ^ Setting ^ Description ^ ^ 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.  | | 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. | | Authentication  | One of the authentication modes described above. |
- +\\ 
-OAuth2 settings: +**OAuth2 settings:**
 ^ Setting ^ Description ^ ^ Setting ^ Description ^
 | Authorization URL  | Defined by the web service you're connecting to. E.g. "https://accounts.google.com/o/oauth2/v2/auth".  | | Authorization URL  | Defined by the web service you're connecting to. E.g. "https://accounts.google.com/o/oauth2/v2/auth".  |
Line 30: Line 37:
 | Parameters  | Optional additional connection parameters specified as key-value pairs as specified by the target web service.  | | Parameters  | Optional additional connection parameters specified as key-value pairs as specified by the target web service.  |
  
-=== Tab Options === +\\ 
 +====Options settings====
 ^ Setting ^ Description ^ ^ Setting ^ Description ^
 | Request timeout  | Time in seconds after which a web request will fail automatically if it's not completed by then. | | Request timeout  | Time in seconds after which a web request will fail automatically if it's not completed by then. |
Line 39: Line 46:
 | Don't send the header "Expect:100-continue"  |By default, EasyMorph sends the header [[https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Expect|"Expect:100-continue"]] automatically when sending a request with a body (e.g., a POST request). The header requires the remote web server to reply with [[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/100|HTTP 100]] (Continue) before receiving the (potentially large) request body. Checking this option prevents EasyMorph from including this header.|   | Don't send the header "Expect:100-continue"  |By default, EasyMorph sends the header [[https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Expect|"Expect:100-continue"]] automatically when sending a request with a body (e.g., a POST request). The header requires the remote web server to reply with [[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/100|HTTP 100]] (Continue) before receiving the (potentially large) request body. Checking this option prevents EasyMorph from including this header.|  
  
-=== Tab Proxy ===+\\ 
 +====Proxy settings====
 Configure proxy settings, if required. Consult your network administrator for proxy settings, if necessary. Configure proxy settings, if required. Consult your network administrator for proxy settings, if necessary.
  
-=== Tab URL parameters ===+\\ 
 +====URL Parameters settings====
 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. 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.+If a "Web request" action also specifies the same URL parameter name but with a different value, the action's setting will take precedence over the connector's setting.
  
-=== Tab Headers ===+\\ 
 +====Headers settings===
 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. 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.+If a "Web request" action also specifies the same header but with a different value, the action's setting will take precedence over the connector's setting.
  
-=== Cookie container ===+\\  
 +=====Remarks===== 
 +====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. 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 ** +\\ 
 +=====See also=====
   * [[transformations:webrequest|Action "Web Request"]]   * [[transformations:webrequest|Action "Web Request"]]
   * [[transformations:iteratewebrequest|Action "Iterate Web Request"]]   * [[transformations:iteratewebrequest|Action "Iterate Web Request"]]
connectors/weblocation.txt · Last modified: 2024/10/29 18:20 by craigt
Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki