Plugins
Plugins can modify HTTP requests and adjust the behaviour of the HTTP connection. For example, plugins can add additional HTTP headers, define a default base URL, or enable request logging. The following plugins are available:| Name | Description |
|---|---|
| Add base URI to requests | Set the base URI for the request. |
| Add content length headers to requests | Calculate and add content length header to the request. |
| Add content type headers to requests | Automatic content type detection and add it to the request headers. |
| Add host to requests | Add the supplied host value to the Host header, can be set to overwrite existing Host header. |
| Add path to requests | Add the supplied URI to the request path. |
| Append request headers | Append a header to the request as a key value pair. |
| Cache requests | Cache the request result for either a user specified time or the cache header value. |
| Follow redirects | Follow request redirects with the option to preserve headers and use location headers. |
| Log requests | Log requests based on the selected formatter. |
| Mock requests | Return a mock response instead of executing the request. |
| Rate limit based on header | Check response headers for the request limit and wait for a set amount of time before resuming. |
| Remove request headers | List of headers that will be removed from the request. |
| Retry requests on failure | Retry a request when the response code matches the supplied failure range. |
| Set UTF-8 encoding | Set encoding for the request to UTF-8 based on the ‘from encoding’ with a user selected error option. |
| Set default headers of requests | Set the default headers for requests. |
| Set request encoding headers | Set encoding headers (TE and Accept-Encoding) for the requests based on user selection. |
| Set request headers | Set a specific list of headers for requests based on the user supplied key value pairs. |
| Store and use cookies | Store and use cookies for the request. |
| Validate the response | Validate the response headers and body based on a set criteria. |
Authentication
Authentication methods can be used to authenticate the HTTP requests performed by the HTTP API connection. Examples include Basic Authentication or OAuth 2. The following authentication methods are available:| Name | Description |
|---|---|
| Amazon Web Service (AWS) | Used to authenticate with AWS endpoints. |
| Amazon Web Service S3 (AWS S3) | Used to authenticate with AWS S3 buckets. |
| Azure Shared Key Authentication | Used to authenticate with Azure using a Shared Key. |
| Basic authentication | Use basic HTTP user/password authentication for the HTTP requests. |
| Bearer token authentication | Use a stored or static token in the HTTP Authentication header. |
| Custom client certificate | Use SSL certificate, key and optional password for request authentication. |
| Google Service Account OAuth2 | Used to authenticate with a Google Service Account. |
| JWT authentication | Use a JWT header and payload for request authentication. |
| Magento 2 integration Oauth1 | Authenticate with Magento 2 using OAuth1 |
| Oauth1 authentication | Used to make for HTTP requests that require OAuth 1 authentication. |
| Oauth2 authentication | Used to make for HTTP requests that require OAuth 2 authentication. |
| Query param authentication | Set a query parameter and value to be used for request authentication. |
| Request authentication | Authenticate by a header value retrieved through a different requests. |
| Request body signing | Signs the request body with a key and attaches the signature as a header. Supports HMAC (SHA-256, SHA-512) and RSA (SHA-256, SHA-512). |
| Wsse authentication | Authenticate the requests using the WSSE standard with a username and password. |