WhoisXML Connector - Ismena website

info@ismena.com

WhoisXML

Connector Details

Type

Virtual machines, Single VM , BYOL

Runs on

Google Compute Engine

Last Update

24 October, 2024

Category

Overview

The WhoisXML Connector facilitates seamless integration providing access to domain and IP address information through WHOIS lookups. This connector acts as a proxy to streamline data retrieval, supporting both GET and POST requests to the WhoisService endpoint for querying domain and IP WHOIS data

Integration Overview

This document provides a detailed guide for the integration point, its purpose, configuration, and workflow support using the WhoisXML API Connector.

Supported Integration Action Points

WhoisService (GET): Retrieves WHOIS information for a domain or IP address using query parameters.
WhoisService (POST): Retrieves WHOIS information for a domain or IP address using a JSON payload.

Detailed Integration Documentation

WHOIS Lookup (GET)

Action	WhoisService (GET)
Purpose	Retrieves WHOIS information for a specified domain or IP address, including details such as registrant information, domain status, and registration dates, using query parameters.
Parameters	Required: apiKey: Your API key for authentication (string, e.g., "YOUR-API-KEY"). Passed via the Authorization header or as a query parameter. domainName: The domain name or IP address to query (string, e.g., "example.com" or "8.8.8.8"). Optional: outputFormat: Desired response format (string, enum: ["JSON", "XML"], default: "JSON"). da: Enable domain availability check (integer, enum: [0, 1], default: 0). getMode: Specify data retrieval mode (string, enum: ["FULL", "BASIC"], default: "FULL"). preferFresh: Prefer fresh WHOIS data over cached data (integer, enum: [0, 1], default: 0). _parse: Enable parsed WHOIS data (integer, enum: [0, 1], default: 1).
Configuration	Ensure the connector is configured with the appropriate environment variables: CONNECTOR_ENV_WHOISXML_BASE_URL: Base URL for the WhoisXML API. CONNECTOR_ENV_PORT: Port for the Flask service (default: 8081). Include a valid Authorization header with the API key (e.g., Bearer YOUR-API-KEY) or pass apiKey as a query parameter.
Output	Successful: Returns a JSON object (or XML if specified) with WHOIS data, including: domainName: The queried domain (string, e.g., "example.com"). registrarName: Registrar name (string, e.g., "GoDaddy.com, LLC"). registrant: Object with registrant details (e.g., name, organization, email). contactEmail: Contact email (string, e.g., "contact@example.com"). createdDate: Domain creation date (string, e.g., "1997-09-15T07:00:00Z"). updatedDate: Last update date (string, e.g., "2023-08-01T12:00:00Z"). expiresDate: Expiration date (string, e.g., "2024-09-14T23:59:59Z"). domainStatus: Domain status (array of strings, e.g., ["clientTransferProhibited"]). nameServers: Array of name servers (e.g., ["ns1.example.com", "ns2.example.com"]). Additional fields based on getMode and _parse settings. Failure: Returns error details (e.g., { "error": { "code": 401, "message": "Invalid API key" } } for unauthorized requests, or status 400 for invalid parameters).
Workflow Example	Execute the WhoisService GET action with domainName=example.com and apiKey=YOUR-API-KEY. Process the response to retrieve WHOIS details such as registrant information and domain status. Use the data for domain verification, compliance, or security analysis.

2.2 WHOIS Lookup (POST)

Action	WhoisService (POST)
Purpose	Retrieves WHOIS information for a specified domain or IP address using a JSON payload, offering the same functionality as the GET action but with support for more complex queries or bulk requests.
Parameters	Required (in JSON payload): apiKey: Your API key for authentication (string, e.g., "YOUR-API-KEY"). Can also be passed via the Authorization header. domainName: The domain name or IP address to query (string, e.g., "example.com" or "8.8.8.8"). Optional (in JSON payload): outputFormat: Desired response format (string, enum: ["JSON", "XML"], default: "JSON"). da: Enable domain availability check (integer, enum: [0, 1], default: 0). getMode: Specify data retrieval mode (string, enum: ["FULL", "BASIC"], default: "FULL"). preferFresh: Prefer fresh WHOIS data over cached data (integer, enum: [0, 1], default: 0). _parse: Enable parsed WHOIS data (integer, enum: [0, 1], default: 1).
Configuration	Ensure the connector is configured with the appropriate environment variables: CONNECTOR_ENV_WHOISXML_BASE_URL: Base URL for the WhoisXML API. CONNECTOR_ENV_PORT: Port for the Flask service (default: 8081). Include a valid Authorization header with the API key (e.g., Bearer YOUR-API-KEY) or include apiKey in the JSON payload.
Output	Successful: Returns a JSON object (or XML if specified) with WHOIS data, including: domainName: The queried domain (string, e.g., "example.com"). registrarName: Registrar name (string, e.g., "GoDaddy.com, LLC"). registrant: Object with registrant details (e.g., name, organization, email). contactEmail: Contact email (string, e.g., "contact@example.com"). createdDate: Domain creation date (string, e.g., "1997-09-15T07:00:00Z"). updatedDate: Last update date (string, e.g., "2023-08-01T12:00:00Z"). expiresDate: Expiration date (string, e.g., "2024-09-14T23:59:59Z"). domainStatus: Domain status (array of strings, e.g., ["clientTransferProhibited"]). nameServers: Array of name servers (e.g., ["ns1.example.com", "ns2.example.com"]). Additional fields based on getMode and _parse settings. Failure: Returns error details (e.g., { "error": { "code": 401, "message": "Invalid API key" } } for unauthorized requests, or status 400 for invalid parameters).
Workflow Example	Execute the WhoisService POST action with a JSON payload: { "domainName": "example.com", "apiKey": "YOUR-API-KEY", "outputFormat": "JSON" }. Process the response to retrieve WHOIS details such as registrant information and domain status. Use the data for domain verification, compliance, or security analysis.

Workflow Creation with the Connector

Example Workflow: Domain WHOIS Lookup

Perform WHOIS Lookup (GET)	Use the WhoisService GET action with domainName=example.com and apiKey=YOUR-API-KEY to retrieve WHOIS data. Confirm the domain’s registration details and status for compliance or monitoring.
Perform WHOIS Lookup (POST)	Execute the WhoisService POST action with a JSON payload: { "domainName": "example.com", "apiKey": "YOUR-API-KEY", "da": 1, "_parse": 1 }. Process the parsed WHOIS data for detailed analysis, such as registrant contact information or name servers.
Analyze and Act	Use the retrieved WHOIS data for domain verification, security checks, or tracking domain expiration dates. Integrate the results into a broader application, such as a domain management or monitoring system.

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