Protection – B2B Custom Administration

This article covers the recommended approach to integrating WEDOS.protection services into your custom administration panel. For more information, as well as other reseller options available to B2B customers, see the article Global – B2B Reseller Options.

In this article, you will learn:


WEDOS.protection API Features

For a more seamless user experience, we recommend our B2B partners to utilize WEDOS API (WAPI for short) and integrate WEDOS services into their own administration panels the end customers are already familiar with.

Before you continue reading, familiarize yourself with WEDOS API by reading the WAPI Manual.

WAPI currently supports the following WEDOS.protection features:

  • Obtaining service (domain) information from the system. You can retrieve a list of all services in your account with the wgp-services-list command, or all the information available about a single service with wgp-domain-info.
  • Adding a service to the system. This includes the wgp-domain-create (attempts to add a domain to the system) and wgp-domain-retry (retries adding the domain in case there’s an error) commands.
  • Managing the domain. You can use WAPI to extend a domain that hasn’t been deleted yet (wgp-domain-renew), remove a domain from the system (wgp-domain-delete) or change the subscription plan (wgp-domain-update-subscription).
  • Applying domain templates. Domain templates will be the easiest way to replicate settings onto your users’ domains. You can utilize the WAPI commands wgp-domain-templates-list to check what templates are available, and wgp-domain-template-replicate to apply a template to a target domain.
  • Clearing the domain cache. Currently the only command available to directly affect WEDOS.protection domain settings is wgp-domain-cache-purge (clears all cached static files for the domain).

For complete information on these commands, see the article WAPI – WEDOS.protection (WGP).


Service Management

The following advice is based on these assumptions:

  • You have a WEDOS B2B customer and credit account. This customer account will be used to create all services you are reselling, and these services will also be billed to that account (via negative credit – for more information, see the article WEDOS – Credit Account or consult your WEDOS sales representative). How you handle billing on your end is entirely up to you.
  • Your customers will be accessing WEDOS.protection services only via your administration panel. This approach requires you to set up WAPI access and use that to let your customers purchase WEDOS products through your account (see above). For more information, see the article Global – B2B Reseller Options.

Based on the WEDOS.protection features currently available via WAPI, we suggest a hybrid approach to managing domains for you and your customers:

  • You: WEDOS.global admin panel. The WEDOS.global admin panel ⧉ currently gives you access to all available settings, including those that haven’t been integrated into WAPI yet. Since all your customers’ interaction with the services will be WAPI-based, you, as the administrator, have to perform some settings using an interface where they are available. For more information, see the chapter WEDOS.global Admin Panel.
  • Your customers: your custom admin panel. We recommend that you create an interface for your customers in your own admin panel using WAPI. This way your customers can manage the services without having to create WEDOS accounts for themselves. For more information, see the chapter Custom Admin Panel.

WEDOS.global Admin Panel

We advise that only you (or your designated administrators) have access to your services via the WEDOS.global admin panel ⧉, and that you maintain a separate interface for your end customers.

The key areas of WEDOS.protection service management which are currently only accessible in the WEDOS.global admin panel ⧉ are:

  • Direct service setup. If you need to perform setup on a single service, such as setting up Filters or Upstream, you need to access that service in the admin panel. If you want to let another person view or perform setup on that service, you can add them as a member (they will, however, need their own WEDOS account).
  • Domain template setup and management. To automate frequent setup routines, you can use the admin panel to set up domain templates and let your customers replicate those onto their services via WAPI using your admin panel.
  • Target IPs and Subdomains. If the end customer’s Target IP addresses or Subdomains change, only the administrator can currently update it. For more information, see the article Protection – DNS and Target IPs (Upstream).
  • Grafana performance monitoring. This monitoring is currently only available to the entire account, rather than individual domains. For more information, see the article Protection – Grafana.

The added benefit of managing all the services you are reselling from our interface is that you have access to any new features immediately, without having to implement them yourself.

Custom Admin Panel

Your end customers should only have access to the WEDOS.protection services you are reselling from your interface. This makes their experience seamless, while you have full control over what settings they can or cannot perform.

We strongly suggest including the following features:

  • Create, renew and delete service. Customers should have the option to add their domains to WEDOS.protection, renew or cancel their subscription.

While running wgp-domain-create, make sure to also periodically check the new service’s status with wgp-domain-info. If you encounter errors, especially error_crt, use wgp-domain-retry to try and fix the issue. For more information, see the article WAPI – WEDOS.protection (WGP).

  • Clear cache. Clearing the cache is especially important when end customers update frequently visited sites (such as the front page) and need their users to see that change immediately. Make sure a Clear Cache button which sends the wgp-domain-cache-purge command is readily available to every customer.

The following features are optional, and we suggest you include them at your own discretion:

  • Manage subscription. While it is convenient to have all your customers use the same subscription plan, you can allow them to change the subscription in your admin panel. Keep in mind that if your customer downgrades their subscription plan, the new price will not take effect immediately, but from the following billing period, while upgrades immediately issue a surcharge fee. You can find more information in the article Protection – Subscription Plan.
  • Quick setup via domain templates. You can create any number of templates in the system and give your customers the ability to replicate them. For example, you can make a template with GeoIP blocking, which allows your users to only allow requests from certain countries or continents with a single click.

Domain templates only apply their values at the time of replication. If you later change a domain template, replicate it again to apply the new settings.


FAQ

Are you planning to release plugins for common administration systems, such as DirectAdmin?

Yes, we are currently developing WEDOS.protection and WEDOS.zone plugins for DirectAdmin. These plugins also utilize WAPI, so you as the administrator will still need to access the WEDOS.global admin panel ⧉ for some features.

Was this helpful?

Thanks for your feedback!
Generic selectors
Exact matches only
Search in title
Search in content
Post Type Selectors