API

WEDOS API (WAPI): Empowering Your Gateway

The WEDOS API—also known as WAPI—is our dedicated interface for managing a wide range of services directly from your information system. Seamlessly integrated with our API Gateway, WAPI ensures that you benefit from our global network’s speed, security, and reliability while managing domains, DNS, credit accounts, and WEDOS Global services.

Key Features of WAPI within Our API Gateway

1. Unified Service Management

  • Comprehensive Domain and Service Operations:
    Manage domains, DNS, NSSET, and WEDOS Global services through a single, consistent interface. Execute commands such as:
    • wgp-domain-create: Add a new domain (asynchronously, with progress tracked via notifications).
    • wgp-domain-info: Retrieve current domain status.
    • wgp-domain-renew / wgp-domain-delete: Renew or terminate services.
    • And more—tailored to your specific needs.
  • Credit Account Integration:
    All service actions are automatically billed against your active credit account, streamlining financial operations.

2. Global-Scale Security & Performance

  • Secure Communication:
    Every WAPI request is transmitted over HTTPS using the POST method with XML or JSON payloads, ensuring your data is encrypted and safe.
  • Robust Authentication:
    Authentication is based on a SHA1 hash mechanism that combines your WEDOS customer account login, a dedicated WAPI password, and the current hour (aligned with the Europe/Prague timezone).
  • Rate Limiting & Abuse Prevention:
    To safeguard resources:
    • A maximum of 1000 requests per hour per user account is enforced.
    • Additional limits (e.g., 100 domain-related requests per hour) help prevent misuse.
    • Repeated invalid requests will temporarily block the offending IP.

3. Synchronous & Asynchronous Operations

  • Quick, Synchronous Requests:
    Commands like ping and poll-req provide near-instant responses, ideal for rapid testing and simple operations.
  • Asynchronous Processing for Complex Tasks:
    For operations that require longer processing (e.g., domain creation), WAPI returns a “Request pending” status (code 1001) and tracks progress via notifications delivered through:
    • POLL Queue: Retrieve and acknowledge notifications.
    • HTTP/HTTPS POST: Receive updates directly to a URL you specify.
    • Email: Stay informed via email alerts.

4. Flexible Activation and Integration

  • Easy WAPI Activation:
    Activate WAPI directly from the customer administration panel. Simply configure:
    • Allowed IP addresses (ensuring only your trusted systems can connect),
    • Notification methods,
    • Preferred protocols for system notifications
    • Your WAPI password.
  • Consistent Request/Response Structure:
    Every WAPI request includes essential elements like:
    • user (your login email),
    • auth (SHA1 hash for secure authentication),
    • command (the specific API operation),
    • Optional clTRID for tracking, and
    • data for command-specific details.

Return Codes & Troubleshooting

WAPI employs standardized return codes to quickly diagnose issues:

  • 1xxx: Successful operations.
  • 2xxx: Invalid requests (e.g., missing parameters).
  • 3xxx: Target object errors (e.g., duplicate domain entries).
  • 4xxx & 5xxx: Request and internal errors, respectively. Specific codes related to WEDOS Global services provide precise error feedback to keep your operations running smoothly.

Conclusion

By integrating WAPI into our API Gateway framework, you gain a secure, fast, and globally distributed platform that streamlines service management and enhances security. Whether you’re automating domain registrations, managing DNS, or overseeing your credit account, WAPI is engineered to empower your operations with the reliability and scalability of our global network.

Explore how our API Gateway and WAPI can transform your system’s connectivity and operational efficiency.

You can find more info about API in our knowledge base.

Přejít nahoru