🌐 Domain Configuration

All Things API (ATA) offers a flexible and powerful domain configuration feature that allows organizations to publish documentation portals under custom domains. This enhances brand consistency, improves external developer trust, and aligns with internal access control and security standards.

✨ Key Capabilities

🏷️ Custom Branding Host documentation under your organization’s domain (e.g., docs.yourcompany.com) for a seamless branded experience.

🔗 Multi-Product Binding A single domain can be linked with multiple products, offering consolidated access.

📊 Version Control and Status Tracking Monitor which versions are associated with each domain and whether they’re in draft or live status.

🧭 Centralized Domain Management View and manage all configured domains from one interface for easier updates and audits.

🛠️ Step-by-Step Guide: Creating and Managing Domains

1️⃣ Accessing Domain Configuration

To begin working with custom domains:

• Navigate to “Domain Configuration” from the sidebar or global settings menu.
• This opens the centralized Domain Management Interface, listing all domains configured under your organization.

2️⃣ Adding a New Domain

To create and bind a new custom domain:

1. Click the “Add New Domain” button at the top-right of the Domain Configuration screen.
2. Enter your desired domain (e.g., api.yourcompany.org, docs.clientx.com) into the input field.
3. Click Save.

3️⃣ Domain List Overview

Once added, domains will appear in a structured list containing the following fields:

• Domain Name: The full web address (e.g., developers.finapi.com)
• Portal Products: Shows all products linked to the domain
• Status: Indicates whether the domain is in Draft, Active, or Archived state
• Created By: The user (name or email) who added the domain
• Created At: Date and time the domain was registered in ATA

4️⃣ Managing Existing Domains

Each domain entry includes an Action Menu (three-dot menu) with the following options:

• Edit
  • Rename the domain
  • Update product bindings
  • Modify metadata or change the status
• Delete
  • Permanently remove the domain
  • Useful for deprecating or cleaning up unused/expired domains

💼 Example Use Cases

📘 Case 1: Branded Developer Portal

FinAPI, a financial services provider, sets up a domain: developers.finapi.com They link all their financial API documentation under this domain to present a unified and professional portal to external developers.

🔒 Case 2: Internal API Access

A private product team configures a restricted domain: internal-docs.projectx.org This domain hosts sensitive documentation and is only accessible to users inside the internal team.

🌐 Case 3: Multi-Brand Agency Environment

A digital agency managing multiple clients creates domains like:

• client1-docs.com
• client2-docs.com

This keeps each client’s documentation separate and branded, improving clarity, control, and customer experience.

✅ Summary

ATA’s Domain Configuration feature empowers organizations to:

• Publish branded and secure API documentation portals
• Link and manage multiple products under unified or separate domains
• Control visibility, access, and branding from a single dashboard

With centralized controls and multi-product support, domain configuration helps scale your API ecosystem while preserving a polished, consistent experience across all touchpoints.