API User Guide

The Webnames API provides programmatic access to domain management services offered by Webnames.ca. It enables developers and businesses to automate tasks such as domain registration, DNS configuration, and contact management, integrating these capabilities directly into their own systems or applications.

This guide is intended to help you understand how to get started with the API, what you need to connect, and how to use it effectively. For detailed technical specifications, please refer to our Webnames API Swagger documentation.

How to Obtain Access to the API

To use the Webnames API, follow these steps:

1. If you have not otherwise done so, purchase the Domain and Account Management Toolkit.
2. Create an appropriate API user via the included multi-user feature.

3. Note the Username and API Key values (which are only displayed once before being one-way hashed).

Client Setup Requirements

Before connecting to the API, ensure the following are in place on your end:

• HTTPS Support: All API requests must be made over HTTPS for security.
• Authentication Headers: Include your API key or token in the request headers as specified in the Swagger documentation.
• JSON Handling: The API uses JSON for request and response bodies. Your application should be able to parse and generate JSON.
• Error Handling: Implement logic to handle HTTP status codes and API-specific error messages.

Primary Functions of the API

The Webnames API supports a wide range of domain-related operations. Key capabilities include:

Domain Search and Registration

• Check domain availability
• Register new domains
• Renew existing domains

Domain Management

• Update domain contact information
• Modify name servers
• Enable/disable domain locking

DNS Management

• Add, update, or delete DNS records (A, CNAME, MX, TXT, etc.)
• Manage DNS templates
• Enable DNSSEC (if supported)

Contact and Account Management

• Retrieve and update contact profiles
• Manage billing and administrative contacts

WHOIS and Domain Status

• Query WHOIS information
• Check domain status and expiry

For a full list of endpoints and parameters, refer to our Swagger documentation.

Common Use Cases

Here are some typical scenarios where the Webnames API is especially useful:

• Automated Domain Provisioning: Hosting providers can use the API to register and configure domains automatically when customers sign up.
• Bulk DNS Management: Enterprises managing many domains can automate DNS updates across their portfolio.
• Domain Monitoring Tools: Developers can build tools to monitor domain status, expiry dates, and WHOIS changes.
• Custom Control Panels: Integrate domain and DNS management into your own user interface or dashboard.
• Reseller Integrations: Resellers can use the API to offer domain services under their own brand.