HTTP(S) (Channel Settings)

Introduction: HTTP and Lobster_data.

See also: General Channel Settings, HTTP (Input Agent), HTTP (Input Agent Cron) and Response Route HTTP(S).

(1) The subtype HTTPS (HTTP over SSL) requires additional certificates. Note: Additionally, a client certificate may be required for the outgoing HTTP(S) connection. The local certificate is also used for this purpose. See also section Authentication by Client Certificate.

(2) The realm is a freely selectable name that, together with the URL, describes a set of HTTP resources that require authentication (with the same access data). See 'Basic Authentication' in section Preemptive Authentication.

(3) This channel type allows OAuth authentication. We will not go into the specific terms of the configuration and would like to refer directly to https://oauth.net/ and https://oauth.net/2/. The goal here is to pick up an access token (and possibly also a refresh token). Note : As soon as something is entered via the buttons, OAuth is activated, i.e. if the channel acts as a client, it initiates the logon to the server via the OAuth process.

(4) If an OAuth2 access token was retrieved via (3), then the expiry time is automatically entered here. Note: The additional IDs will then contain an entry with name SYS_HTTP_OAUTH2.

(5) If a valid refresh URL is entered here and there is a refresh token, a new access token is automatically retrieved (and stored in the channel) for each HTTP access via this channel if (4) has expired (resp. already 20 seconds before that). The expiration time (4) will be reset and the refresh token will also be updated. Note: A refresh token is stored in the additional IDs as an entry with name SYS_HTTP_OAUTH2_REFRESH. Note: You can also use placeholders and system constants in the URL. The corresponding values for the placeholders are taken from (3). In addition to the placeholders used in the example below, you can use placeholder <server>. This placeholder be filled with the content of field Partner address in the channel. If that field, for example, contains the value https://example.com, then <server> will be replaced with example.com. Example: https://example.com/oauth/token?grant_type=refresh_token&client_id=<clientId>&client_secret=<clientSecret>&refresh_token=<refreshToken>

(6) Here the refresh (5) can be triggered manually for test purposes. See also function refresh OAUTH2 access token(a,b,c,d,e,f,g,h). Note: If you can add &useCredentialsInHeader to the URL in (5), the credentials are specified in the header instead of the body.