Httpbin Connector - Ismena website

info@ismena.com

Httpbin Connector

Connector Details

Type

Virtual machines, Single VM , BYOL

Runs on

Google Compute Engine

Last Update

24 October, 2024

Category

Overview

The Httpbin Connector enables seamless integration with the Httpbin API, a simple HTTP Request & Response Service designed for testing HTTP client implementations on Google Cloud Platform (GCP). This connector acts as a proxy to streamline interaction with Httpbin endpoints, supporting a wide range of actions for testing request/response cycles, authentication, cookies, redirects, status codes, and content encoding. It is ideal for developers building and validating HTTP-based applications.

Integration Overview

This document provides a detailed guide for each integration point supported by the Httpbin Connector, outlining its purpose, configuration, and workflow support.

Supported Integration Action Points

deleteAnything: Returns DELETE request data for the /anything endpoint.
deleteAnythingWithPath: Returns DELETE request data with a path parameter.
deleteDelay: Returns a delayed DELETE response.
deleteRequest: Echoes back DELETE request data.
deleteRedirectTo: Redirects to a specified URL using DELETE.
deleteStatus: Returns a specified status code for a DELETE request.
absoluteRedirect: Performs absolute redirects a specified number of times.
getAnything: Returns GET request data for the /anything endpoint.
getAnythingWithPath: Returns GET request data with a path parameter.
getBase64: Decodes a base64url-encoded string.
basicAuth: Tests HTTP Basic Authentication.
bearerAuth: Tests Bearer Token Authentication.
getBrotli: Returns Brotli-encoded data.
getBytes: Generates random bytes.
getCache: Returns a cacheable response.
setCacheControl: Sets a Cache-Control header.
getCookies: Retrieves cookie data.
deleteCookies: Deletes cookies specified in the query string.
setCookies: Sets cookies from the query string.
setCookie: Sets a specific cookie with a name and value.
getDeflate: Returns Deflate-encoded data.
getDelay: Returns a delayed GET response.
getDeny: Returns a page denied by robots.txt rules.
digestAuth: Tests Digest Authentication.
digestAuthWithAlgorithm: Tests Digest Authentication with a specified algorithm.
digestAuthWithStale: Tests Digest Authentication with a stale-after period.
getDrip: Drips data over a duration.
getUtf8: Returns a UTF-8 encoded body.
getEtag: Responds to ETag headers.
getRequest: Retrieves details about a GET request.
getGzip: Returns GZip-encoded data.
getHeaders: Retrieves request headers.
hiddenBasicAuth: Tests hidden HTTP Basic Authentication.
getHtml: Returns a simple HTML document.
getImage: Returns an image based on the Accept header.
getJpegImage: Returns a JPEG image.
getPngImage: Returns a PNG image.
getSvgImage: Returns an SVG image.
getWebpImage: Returns a WEBP image.
getIp: Retrieves the client’s IP address.
getJson: Returns a simple JSON document.
getLinks: Generates a page with links.
getRange: Streams random bytes.
getRedirectTo: Redirects to a specified URL.
redirect: Performs redirects a specified number of times.
relativeRedirect: Performs relative redirects a specified number of times.
getResponseHeaders: Returns custom response headers.
getRobotsTxt: Returns robots.txt rules.
getStatus: Returns a specified status code.
getStreamBytes: Streams random bytes.
getStream: Streams JSON responses.
getUserAgent: Retrieves the client’s User-Agent.
getUuid: Returns a UUID4.
getXml: Returns a simple XML document.
patchAnything: Returns PATCH request data for the /anything endpoint.
patchAnythingWithPath: Returns PATCH request data with a path parameter.
patchDelay: Returns a delayed PATCH response.
patchRequest: Echoes back PATCH request data.
patchRedirectTo: Redirects to a specified URL using PATCH.
patchStatus: Returns a specified status code for a PATCH request.
postAnything: Returns POST request data for the /anything endpoint.
postAnythingWithPath: Returns POST request data with a path parameter.
postDelay: Returns a delayed POST response.
postRedirectTo: Redirects to a specified URL using POST.
postResponseHeaders: Returns custom response headers for a POST request.
postStatus: Returns a specified status code for a POST request.
putAnything: Returns PUT request data for the /anything endpoint.
putAnythingWithPath: Returns PUT request data with a path parameter.
putDelay: Returns a delayed PUT response.
putRequest: Echoes back PUT request data.
putRedirectTo: Redirects to a specified URL using PUT.
putStatus: Returns a specified status code for a PUT request.

Detailed Integration Documentation

DELETE Anything

Action	deleteAnythingWithPath
Purpose	Returns data from a DELETE request to /anything/{anything}, including the path parameter.
Parameters	Required: anything: Path parameter (string, e.g., test). Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns a JSON object similar to deleteAnything. Failure: Returns error status (e.g., 400).
Workflow Example	Execute the deleteAnythingWithPath action with anything=test. Confirm the path parameter is reflected in the response. Use for testing dynamic DELETE endpoints.

DELETE Anything with Path

Action	deleteAnythingWithPath
Purpose	Returns data from a DELETE request to /anything/{anything}, including the path parameter.
Parameters	Required: anything: Path parameter (string, e.g., test). Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns a JSON object similar to deleteAnything. Failure: Returns error status (e.g., 400).
Workflow Example	Execute the deleteAnythingWithPath action with anything=test. Confirm the path parameter is reflected in the response. Use for testing dynamic DELETE endpoints.

DELETE Delayed Response

Action	deleteDelay
Purpose	Returns a delayed DELETE response (max 10 seconds). Useful for testing timeout handling.
Parameters	Required: delay: Delay in seconds (number, 0-10, e.g., 5). Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns a JSON object with request details. Failure: Returns error status (e.g., 400 for invalid delay).
Workflow Example	Execute the deleteDelay action with delay=5. Verify the response is delayed appropriately. Use for testing client timeout behavior.

DELETE Request

Action	deleteRequest
Purpose	Echoes back DELETE request data, including query parameters, headers, origin IP, and URL.
Parameters	Required: None Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns a JSON object with request details. Failure: Returns error status (e.g., 400).
Workflow Example	Execute the deleteRequest action. Verify the response echoes request details. Use for testing DELETE request handling.

DELETE Redirect

Action	deleteRedirectTo
Purpose	Redirects to a specified URL using DELETE with an optional status code.
Parameters	Required: url: Target URL (string, format: URI, e.g., https://example.com). Optional: status_code: Redirect status code (integer, enum: 301, 302, 303, 307, 308, default: 302).
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (301-308): Redirects with Location header.
Workflow Example	Execute the deleteRedirectTo action with url=https://example.com. Verify the client follows the redirect. Use for testing DELETE redirect logic.

DELETE Status

Action	deleteStatus
Purpose	Returns a specified status code for a DELETE request.
Parameters	Required: codes: HTTP status code(s) (string, e.g., 404 or 200,404,500). Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful: Returns the specified or random status code with a text body.
Workflow Example	Execute the deleteStatus action with codes=404. Verify the 404 status code response. Use for testing DELETE error handling.

Absolute Redirect

Action	absoluteRedirect
Purpose	Performs absolute redirects a specified number of times.
Parameters	Required: n: Number of redirects (integer, minimum: 1). Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (302): Redirects with Location header.
Workflow Example	Execute the absoluteRedirect action with n=3. Verify the client follows multiple redirects. Use for testing redirect chains.

GET Anything

Action	getAnything
Purpose	Returns data from a GET request to the /anything endpoint.
Parameters	Required: None Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns a JSON object with request details.
Workflow Example	Execute the getAnything action. Verify the response contains request details. Use for testing GET request handling.

GET Anything with Path

Action	getAnythingWithPath
Purpose	Returns data from a GET request to /anything/{anything}.
Parameters	Required: anything: Path parameter (string). Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns a JSON object with request details.
Workflow Example	Execute the getAnythingWithPath action with anything=test. Confirm the path parameter is included. Use for testing dynamic GET endpoints.

Base64 Decoding

Action	getBase64
Purpose	Decodes a base64url-encoded string.
Parameters	Required: value: Base64url-encoded string (string). Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns the decoded string (text/plain).
Workflow Example	Execute the getBase64 action with value=SGVsbG8=. Verify the decoded result (Hello). Use for testing base64 decoding.

Basic Authentication

Action	basicAuth
Purpose	Tests HTTP Basic Authentication with provided credentials.
Parameters	Required: user: Username (string). passwd: Password (string). Optional: None
Configuration	Provide credentials via Basic Auth headers.
Output	Successful (200): Returns { "authenticated": true, "user": string }. Failure (401): Returns { "authenticated": false, "user": null }.
Workflow Example	Execute the basicAuth action with user=testuser, passwd=testpass. Verify successful authentication. Use for testing Basic Auth.

Bearer Token Authentication

Action	bearerAuth
Purpose	Tests Bearer Token Authentication.
Parameters	Required: None Optional: None
Configuration	Provide Bearer token in Authorization header.
Output	Successful (200): Returns { "authenticated": true, "token": string }. Failure (401): Returns { "authenticated": false, "token": null }.
Workflow Example	Execute the bearerAuth action with a Bearer token. Verify token validation. Use for testing Bearer Auth.

Brotli-Encoded Data

Action	getBrotli
Purpose	Returns Brotli-encoded data.
Parameters	Required: None Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns Brotli-encoded content (application/octet-stream).
Workflow Example	Execute the getBrotli action. Verify client can decode Brotli content. Use for testing content encoding.

Random Bytes

Action	getBytes
Purpose	Generates random bytes.
Parameters	Required: n: Number of bytes (integer, minimum: 1). Optional: seed: Random seed (integer).
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns random bytes (application/octet-stream). Failure (400): Returns error for invalid n.
Workflow Example	Execute the getBytes action with n=100. Verify the response contains random bytes. Use for testing binary data handling.

Cacheable Response

Action	getCache
Purpose	Returns a cacheable response or 304 if cached.
Parameters	Required: None Optional: None Configuration: Ensure the connector is configured with the base URL.
Output	Successful (200): Returns a JSON object. Not Modified (304): Returns empty response if cached.
Workflow Example	Execute the getCache action with If-Modified-Since header. Verify 304 response for cached content. Use for testing caching mechanisms.
Action	setCacheControl
Purpose	Sets a Cache-Control header for a specified duration.
Parameters	Required: value: Seconds for Cache-Control (integer). Optional: None Configuration: Ensure the connector is configured with the base URL.
Output	Successful (200): Returns a JSON object with Cache-Control header.
Workflow Example	Execute the setCacheControl action with value=3600. Verify the Cache-Control header. Use for testing caching behavior.

Set Cache-Control

Action	setCacheControl
Purpose	Sets a Cache-Control header for a specified duration.
Parameters	Required: value: Seconds for Cache-Control (integer). Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns a JSON object with Cache-Control header.
Workflow Example	Execute the setCacheControl action with value=3600. Verify the Cache-Control header. Use for testing caching behavior.

Cookies Retrieval

Action	getCookies
Purpose	Retrieves cookie data from the request.
Parameters	Required: None Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns { "cookies": object }.
Workflow Example	Execute the getCookies action with cookies in the request. Verify cookies in the response. Use for testing cookie handling.

Delete Cookies

Action	deleteCookies
Purpose	Deletes cookies specified in the query string and redirects to /cookies.
Parameters	Required: None Optional: cookies: Cookie names to delete (object).
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (302): Redirects to /cookies with Set-Cookie header.
Workflow Example	Execute the deleteCookies action with cookies={ "session": "" }. Follow redirect to verify cookies are deleted. Use for testing cookie removal.

Set Cookies

Action	setCookies
Purpose	Sets cookies from the query string and redirects to /cookies.
Parameters	Required: None Optional: cookies: Cookie key-value pairs (object).
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (302): Redirects to /cookies with Set-Cookie header.
Workflow Example	Execute the setCookies action with cookies={ "session": "abc123" }. Follow redirect to verify cookies. Use for testing cookie creation.

Set Specific Cookie

Action	setCookie
Purpose	Sets a specific cookie with a name and value, redirecting to /cookies.
Parameters	Required: name: Cookie name (string). value: Cookie value (string). Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (302): Redirects to /cookies with Set-Cookie header.
Workflow Example	Execute the setCookie action with name=session, value=abc123. Follow redirect to verify cookie. Use for testing specific cookie setting.

Deflate-Encoded Data

Action	getDeflate
Purpose	Returns Deflate-encoded data.
Parameters	Required: None Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns Deflate-encoded content (application/octet-stream).
Workflow Example	Execute the getDeflate action. Verify client can decode Deflate content. Use for testing content encoding.

Delayed GET Response

Action	getDelay
Purpose	Returns a delayed GET response (max 10 seconds).
Parameters	Required: delay: Delay in seconds (number, 0–10). Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns a JSON object with request details. Failure: Returns error status (e.g., 400).
Workflow Example	Execute the getDelay action with delay=5. Verify delayed response. Use for testing timeout handling.

Denied Page

Action	getDeny
Purpose	Returns a page denied by robots.txt rules.
Parameters	Required: None Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (403): Returns a text/plain denied message.
Workflow Example	Execute the getDeny action. Verify the 403 response. Use for testing robots.txt restrictions.

Digest Authentication

Action	digestAuth
Purpose	Tests Digest Authentication with quality of protection, username, and password.
Parameters	Required: qop: Quality of protection (string, enum: auth, auth-int). user: Username (string). passwd: Password (string). Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns { "authenticated": true, "user": string }. Failure (401): Returns { "authenticated": false, "user": null }.
Workflow Example	Execute the digestAuth action with qop=auth, user=testuser, passwd=testpass. Verify authentication. Use for testing Digest Auth.

Digest Authentication with Algorithm

Action	digestAuthWithAlgorithm
Purpose	Tests Digest Authentication with a specified algorithm.
Parameters	Required: qop: Quality of protection (string, enum: auth, auth-int). user: Username (string). passwd: Password (string). algorithm: Digest algorithm (string, enum: MD5, SHA-256, SHA-512). Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns { "authenticated": true, "user": string }. Failure (401): Returns { "authenticated": false, "user": null }.
Workflow Example	Execute the digestAuthWithAlgorithm action with algorithm=MD5. Verify authentication. Use for testing algorithm-specific Digest Auth.

Digest Authentication with Stale After

Action	digestAuthWithStale
Purpose	Tests Digest Authentication with a stale-after period.
Parameters	Required: qop: Quality of protection (string, enum: auth, auth-int). user: Username (string). passwd: Password (string). algorithm: Digest algorithm (string, enum: MD5, SHA-256, SHA-512). stale_after: Number of requests for nonce staleness (integer). Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns { "authenticated": true, "user": string }. Failure (401): Returns { "authenticated": false, "user": null }.
Workflow Example	Execute the digestAuthWithStale action with stale_after=10. Verify authentication and nonce behavior. Use for testing stale nonce handling.

Drip Data

Action	getDrip
Purpose	Drips data over a duration with an optional delay.
Parameters	Required: None Optional: duration: Duration to drip data (number, seconds). delay: Initial delay (number, seconds). numbytes: Total bytes to drip (integer). code: HTTP status code (integer, default: 200).
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns dripped data (application/octet-stream).
Workflow Example	Execute the getDrip action with duration=5, numbytes=100. Verify data is dripped over time. Use for testing streaming responses.

UTF-8 Encoded Body

Action	getUtf8
Purpose	Returns a UTF-8 encoded body.
Parameters	Required: None Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns a UTF-8 encoded text/plain response.
Workflow Example	Execute the getUtf8 action. Verify UTF-8 encoding. Use for testing text encoding.

ETag Response

Action	getEtag
Purpose	Responds to ETag headers with the given ETag value.
Parameters	Required: etag: ETag value (string). Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns a JSON object if ETag matches. Not Modified (304): Returns empty response if ETag is unchanged.
Workflow Example	Execute the getEtag action with etag=abc123. Verify ETag handling with If-None-Match. Use for testing ETag caching.

GET Request Details

Action	getRequest
Purpose	Retrieves details about a GET request, including query parameters, headers, origin IP, and URL.
Parameters	Required: None Optional: show_env: Include environment headers (string, enum: 1).
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns a JSON object with request details.
Workflow Example	Execute the getRequest action with show_env=1. Verify headers and query parameters. Use for testing GET requests.

GZip-Encoded Data

Action	getGzip
Purpose	Returns GZip-encoded data.
Parameters	Required: None Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns GZip-encoded content (application/octet-stream).
Workflow Example	Execute the getGzip action. Verify client can decode GZip content. Use for testing content encoding.

Request Headers

Action	getHeaders
Purpose	Retrieves request headers as a JSON object.
Parameters	Required: None Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns { "headers": object }.
Workflow Example	Execute the getHeaders action. Verify headers in the response. Use for debugging headers.

Hidden Basic Authentication

Action	hiddenBasicAuth
Purpose	Tests hidden HTTP Basic Authentication without a visible 401 response.
Parameters	Required: user: Username (string). passwd: Password (string). Optional: None
Configuration	Provide credentials via Basic Auth headers.
Output	Successful (200): Returns { "authenticated": true, "user": string }. Failure (404): Returns { "authenticated": false, "user": null }.
Workflow Example	Execute the hiddenBasicAuth action with user=testuser, passwd=testpass. Verify authentication without 401. Use for testing hidden auth.

HTML Document

Action	getHtml
Purpose	Returns a simple HTML document.
Parameters	Required: None Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns an HTML document (text/html).
Workflow Example	Execute the getHtml action. Verify HTML rendering. Use for testing HTML handling.

Image Retrieval

Action	getImage
Purpose	Returns an image based on the Accept header.
Parameters	Required: None Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns an image (image/*).
Workflow Example	Execute the getImage action with Accept: image/png. Verify image response. Use for testing image handling.

JPEG Image

Action	getJpegImage
Purpose	Returns a JPEG image.
Parameters	Required: None Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns a JPEG image (image/jpeg).
Workflow Example	Execute the getJpegImage action. Verify JPEG response. Use for testing image formats.

PNG Image

Action	getPngImage
Purpose	Returns a PNG image.
Parameters	Required: None Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns a PNG image (image/png).
Workflow Example	Execute the getPngImage action. Verify PNG response. Use for testing image formats.

SVG Image

Action	getSvgImage
Purpose	Returns an SVG image.
Parameters	Required: None Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns an SVG image (image/svg+xml).
Workflow Example	Execute the getSvgImage action. Verify SVG response. Use for testing vector images.

WEBP Image

Action	getWebpImage
Purpose	Returns a WEBP image.
Parameters	Required: None Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns a WEBP image (image/webp).
Workflow Example	Execute the getWebpImage action. Verify WEBP response. Use for testing modern image formats.

Client IP Address

Action	getIp
Purpose	Retrieves the client’s IP address.
Parameters	Required: None Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns { "origin": string }.
Workflow Example	Execute the getIp action. Verify IP address. Use for client identification.

JSON Document

Action	getJson
Purpose	Returns a simple JSON document.
Parameters	Required: None Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns a JSON object.
Workflow Example	Execute the getJson action. Verify JSON parsing. Use for testing JSON handling.

Page with Links

Action	getLinks
Purpose	Generates a page with a specified number of links.
Parameters	Required: n: Number of links (integer). offset: Offset for link generation (integer). Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns an HTML page with links (text/html).
Workflow Example	Execute the getLinks action with n=10, offset=0. Verify links in the HTML. Use for testing link navigation.

Stream Random Bytes

Action	getRange
Purpose	Streams random bytes with a given seed and chunk size.
Parameters	Required: numbytes: Number of bytes to stream (integer, minimum: 1). Optional: seed: Random seed (integer). chunk_size: Size of each chunk (integer).
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns streamed bytes (application/octet-stream).
Workflow Example	Execute the getRange action with numbytes=1000. Verify streamed data. Use for testing streaming.

Redirect to URL

Action	getRedirectTo
Purpose	Redirects to a specified URL with an optional status code.
Parameters	Required: url: Target URL (string, format: URI). Optional: status_code: Redirect status code (integer, enum: 301, 302, 303, 307, 308, default: 302).
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (301-308): Redirects with Location header.
Workflow Example	Execute the getRedirectTo action with url=https://example.com. Verify redirect. Use for testing redirects.

Redirect N Times

Action	redirect
Purpose	Performs 302 redirects a specified number of times.
Parameters	Required: n: Number of redirects (integer, minimum: 1). Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (302): Redirects with Location header.
Workflow Example	Execute the redirect action with n=3. Verify multiple redirects. Use for testing redirect chains.

Relative Redirect

Action	relativeRedirect
Purpose	Performs relative redirects a specified number of times.
Parameters	Required: n: Number of redirects (integer, minimum: 1). Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (302): Redirects with Location header.
Workflow Example	Execute the relativeRedirect action with n=3. Verify relative redirect chain. Use for testing relative redirects.

Response Headers

Action	getResponseHeaders
Purpose	Returns custom response headers from the query string.
Parameters	Required: None Optional: headers: Header key-value pairs (object).
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns a JSON object with specified headers.
Workflow Example	Execute the getResponseHeaders action with headers={ "X-Test": "value" }. Verify response headers. Use for testing custom headers.

Robots.txt Rules

Action	getRobotsTxt
Purpose	Returns robots.txt rules.
Parameters	Required: None Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns robots.txt content (text/plain).
Workflow Example	Execute the getRobotsTxt action. Verify robots.txt rules. Use for testing SEO compliance.

Specified Status Code

Action	getStatus
Purpose	Returns a specified status code for a GET request.
Parameters	Required: codes: HTTP status code(s) (string, e.g., 404). Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful: Returns the specified status code with a text body.
Workflow Example	Execute the getStatus action with codes=404. Verify 404 response. Use for testing status code handling.

Stream Random Bytes

Action	getStreamBytes
Purpose	Streams random bytes with a given seed and chunk size.
Parameters	Required: n: Number of bytes (integer, minimum: 1). Optional: seed: Random seed (integer). chunk_size: Size of each chunk (integer).
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns streamed bytes (application/octet-stream).
Workflow Example	Execute the getStreamBytes action with n=1000. Verify streamed data. Use for testing streaming.

Stream JSON Responses

Action	getStream
Purpose	Streams a specified number of JSON responses.
Parameters	Required: n: Number of JSON responses (integer, minimum: 1). Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns streamed JSON array.
Workflow Example	Execute the getStream action with n=5. Verify streamed JSON responses. Use for testing JSON streaming.

User-Agent Retrieval

Action	getUserAgent
Purpose	Retrieves the client’s User-Agent header.
Parameters	Required: None Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns { "user-agent": string }.
Workflow Example	Execute the getUserAgent action. Verify User-Agent value. Use for client identification.

UUID4 Generation

Action	getUuid
Purpose	Returns a UUID4.
Parameters	Required: None Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns { "uuid": string }.
Workflow Example	Execute the getUuid action. Verify UUID format. Use for generating unique IDs.

XML Document

Action	getXml
Purpose	Returns a simple XML document.
Parameters	Required: None Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns an XML document (application/xml).
Workflow Example	Execute the getXml action. Verify XML parsing. Use for testing XML handling.

PATCH Anything

Action	patchAnything
Purpose	Returns data from a PATCH request to the /anything endpoint.
Parameters	Required: None Optional: None Request Body: Supports application/json.
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns a JSON object with request details and body.
Workflow Example	Execute the patchAnything action with a JSON body. Verify echoed data. Use for testing PATCH requests.

PATCH Anything with Path

Action	patchAnythingWithPath
Purpose	Returns data from a PATCH request to /anything/{anything}.
Parameters	Required: anything: Path parameter (string). Optional: None
Request Body	Supports application/json.
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns a JSON object with request details and body.
Workflow Example	Execute the patchAnythingWithPath action with anything=test. Verify path parameter and body. Use for testing dynamic PATCH requests.

PATCH Delayed Response

Action	patchDelay
Purpose	Returns a delayed PATCH response (max 10 seconds).
Parameters	Required: delay: Delay in seconds (number, 0-10). Optional: None
Request Body	Supports application/json.
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns a JSON object with request details and body.
Workflow Example	Execute the patchDelay action with delay=5. Verify delayed response. Use for testing PATCH timeouts.

PATCH Request

Action	patchRequest
Purpose	Echoes back PATCH request data, including query parameters, headers, and body.
Parameters	Required: None Optional: None
Request Body	Supports application/json.
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns a JSON object with request details and body.
Workflow Example	Execute the patchRequest action with a JSON body. Verify echoed data. Use for testing PATCH handling.

PATCH Redirect

Action	patchRedirectTo
Purpose	Redirects to a specified URL using PATCH.
Parameters	Required: url: Target URL (string, format: URI). Optional: status_code: Redirect status code (integer, enum: 301, 302, 303, 307, 308, default: 302).
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (301-308): Redirects with Location header.
Workflow Example	Execute the patchRedirectTo action with url=https://example.com. Verify redirect. Use for testing PATCH redirects.

PATCH Status

Action	patchStatus
Purpose	Returns a specified status code for a PATCH request.
Parameters	Required: codes: HTTP status code(s) (string). Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful: Returns the specified status code with a text body.
Workflow Example	Execute the patchStatus action with codes=404. Verify 404 response. Use for testing PATCH status codes.

POST Anything

Action	postAnything
Purpose	Returns data from a POST request to the /anything endpoint.
Parameters	Required: None Optional: None
Request Body	Supports application/json.
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns a JSON object with request details and body.
Workflow Example	Execute the postAnything action with a JSON body. Verify echoed data. Use for testing POST requests.

POST Anything with Path

Action	postAnythingWithPath
Purpose	Returns data from a POST request to /anything/{anything}.
Parameters	Required: anything: Path parameter (string). Optional: None
Request Body	Supports application/json.
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns a JSON object with request details and body.
Workflow Example	Execute the postAnythingWithPath action with anything=test. Verify path parameter and body. Use for testing dynamic POST requests.

POST Delayed Response

Action	postDelay
Purpose	Returns a delayed POST response (max 10 seconds).
Parameters	Required: delay: Delay in seconds (number, 0-10). Optional: None Request Body: Supports application/json.
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns a JSON object with request details and body.
Workflow Example	Execute the postDelay action with delay=5. Verify delayed response. Use for testing POST timeouts.

POST Redirect

Action	postRedirectTo
Purpose	Redirects to a specified URL using POST.
Parameters	Required: url: Target URL (string, format: URI). Optional: status_code: Redirect status code (integer, enum: 301, 302, 303, 307, 308, default: 302).
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (301-308): Redirects with Location header.
Workflow Example	Execute the postRedirectTo action with url=https://example.com. Verify redirect. Use for testing POST redirects.

POST Response Headers

Action	postResponseHeaders
Purpose	Returns custom response headers for a POST request.
Parameters	Required: None Optional: headers: Header key-value pairs (object).
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns a JSON object with specified headers.
Workflow Example	Execute the postResponseHeaders action with headers={ "X-Test": "value" }. Verify response headers. Use for testing custom headers.

POST Status

Action	postStatus
Purpose	Returns a specified status code for a POST request.
Parameters	Required: codes: HTTP status code(s) (string). Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful: Returns the specified status code with a text body.
Workflow Example	Execute the postStatus action with codes=404. Verify 404 response. Use for testing POST status codes.

PUT Anything

Action	putAnything
Purpose	Returns data from a PUT request to the /anything endpoint.
Parameters	Required: None Optional: None Request Body: Supports application/json.
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns a JSON object with request details and body.
Workflow Example	Execute the putAnything action with a JSON body. Verify echoed data. Use for testing PUT requests.

PUT Anything with Path

Action	putAnythingWithPath
Purpose	Returns data from a PUT request to /anything/{anything}.
Parameters	Required: anything: Path parameter (string). Optional: None Request Body: Supports application/json.
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns a JSON object with request details and body.
Workflow Example	Execute the putAnythingWithPath action with anything=test. Verify path parameter and body. Use for testing dynamic PUT requests.

PUT Delayed Response

Action	putDelay
Purpose	Returns a delayed PUT response (max 10 seconds).
Parameters	Required: delay: Delay in seconds (number, 0-10). Optional: None Request Body: Supports application/json.
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns a JSON object with request details and body.
Workflow Example	Execute the putDelay action with delay=5. Verify delayed response. Use for testing PUT timeouts.

PUT Request

Action	putRequest
Purpose	Echoes back PUT request data, including query parameters, headers, and body.
Parameters	Required: None Optional: None Request Body: Supports application/json.
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (200): Returns a JSON object with request details and body.
Workflow Example	Execute the putRequest action with a JSON body. Verify echoed data. Use for testing PUT handling.

PUT Redirect

Action	putRedirectTo
Purpose	Redirects to a specified URL using PUT.
Parameters	Required: url: Target URL (string, format: URI). Optional: status_code: Redirect status code (integer, enum: 301, 302, 303, 307, 308, default: 302).
Configuration	Ensure the connector is configured with the base URL.
Output	Successful (301-308): Redirects with Location header.
Workflow Example	Execute the putRedirectTo action with url=https://example.com. Verify redirect. Use for testing PUT redirects.

PUT Status

Action	putStatus
Purpose	Returns a specified status code for a PUT request.
Parameters	Required: codes: HTTP status code(s) (string). Optional: None
Configuration	Ensure the connector is configured with the base URL.
Output	Successful: Returns the specified status code with a text body.
Workflow Example	Execute the putStatus action with codes=404. Verify 404 response. Use for testing PUT status codes.

Workflow Creation with the Connector

Comprehensive HTTP Client Testing

Client Identification

Use getIp to retrieve the client’s IP address.
Use getUserAgent to identify the client’s User-Agent.
Log details for client tracking.

Request Testing

Execute getRequest, postRequest, putRequest, patchRequest, and deleteRequest to test HTTP methods.
Use getAnything, postAnything, etc., for flexible request testing.
Verify request details in responses.

Authentication Testing

Execute basicAuth, bearerAuth, digestAuth, and hiddenBasicAuth to test authentication mechanisms.
Verify authentication responses.

Cookie Management

Use setCookies and setCookie to set cookies.
Use getCookies to verify cookies.
Use deleteCookies to remove cookies.

Redirect Testing

Execute getRedirectTo, absoluteRedirect, relativeRedirect, and redirect to test redirect handling.
Verify redirect chains and status codes.

Status Code Testing

Use getStatus, postStatus, putStatus, patchStatus, and deleteStatus to test status code handling.
Verify expected status codes.

Content and Encoding

Execute getJson, getHtml, getXml for content format testing.
Use getBrotli, getDeflate, getGzip for encoding tests.
Use getImage, getJpegImage, etc., for image handling.

Advanced Testing

Use getDelay, postDelay, etc., for timeout testing.
Execute getStream, getStreamBytes, and getRange for streaming tests.
Use getUuid for unique ID generation.

This workflow ensures comprehensive testing of HTTP clients, covering requests, authentication, cookies, redirects, status codes, and content handling.

Pricing

bill-and-calculator-2023-11-27-05-25-06-utc 1

Request a Quote

Support

For Technical support please contact us on

custom-connectors-support@isolutions.sa

A tech solution company dedicated to providing innovation thus empowering businesses to thrive in the digital age.

Register to IBM x iSolution Event