Criar uma integração personalizada de registrar

O addon Domain Seller usa um padrão de Integration Registry. Cada registrar é uma classe PHP que implementa Domain_Selling_Capability e regista-se através do action hook wu_domain_seller_register_capabilities.

Este guia mostra como ligar um registrar personalizado.

A interface

A sua classe deve implementar WP_Ultimo\Integrations\Capabilities\Domain_Selling_Capability e estender WP_Ultimo\Integrations\Base_Capability_Module.

Métodos obrigatórios:

namespace My\Plugin\Capabilities;

use WP_Ultimo\Integrations\Base_Capability_Module;
use WP_Ultimo\Integrations\Capabilities\Domain_Selling_Capability;

class My_Registrar_Selling extends Base_Capability_Module implements Domain_Selling_Capability {

    // --- Required identity methods (from Base_Capability_Module) ---

    public function get_capability_id(): string {
        return 'domain-selling';  // always 'domain-selling'
    }

    public function get_title(): string {
        return __('Domain Selling', 'my-plugin');
    }

    public function get_explainer_lines(): array {
        return [
            'will'     => [__('Enable domain registration via My Registrar.', 'my-plugin')],
            'will_not' => [],
        ];
    }

    // --- Core required methods (from Domain_Selling_Capability) ---

    /** Pull all available TLDs and wholesale pricing. */
    public function sync_tlds(): array { ... }

    /** Check availability of $domain_name across $tlds. */
    public function search_domains(string $domain_name, array $tlds = []): array { ... }

    /** Get wholesale price for a TLD for N years. */
    public function get_domain_pricing(string $tld, int $years = 1): array { ... }

    /** Register a domain. Returns ['success' => true, 'expiry_date' => '...'] on success. */
    public function register_domain(string $domain_name, array $registrant_info, int $years = 1): array { ... }

    /** Renew a domain for N years. */
    public function renew_domain(string $domain_name, int $years = 1): array { ... }

    /** Get registration status, expiry date, nameservers. */
    public function get_domain_info(string $domain_name): array { ... }

    /** Test API credentials and connectivity. */
    public function test_connection(): array { ... }
}

Métodos opcionais

Implemente estes para desbloquear funcionalidades adicionais. O addon deteta suporte através de method_exists():

Método	Desbloqueia
supports_whois_privacy(): bool	Opção de privacidade WHOIS nas definições do produto
enable_whois_privacy(string $domain_name): array	Ativa automaticamente a privacidade no registo
get_dns_records(string $domain_name): array	Separador de visualização de DNS do cliente
add_dns_record(string $domain_name, array $record_data): array	O cliente pode adicionar registos DNS
update_dns_record(string $domain, string $record_id, array $record_data): array	O cliente pode editar registos DNS
delete_dns_record(string $domain, string $record_id, array $data): array	O cliente pode eliminar registos DNS
update_nameservers(string $domain_name, array $nameservers): array	Gestão de nameservers
get_epp_code(string $domain_name): array	Transferência de domínio (saída)
transfer_domain(string $domain, string $auth_code, array $registrant_info, array $options): array	Transferência de domínio (entrada)

Convenção do valor de retorno

Todos os métodos devolvem um array com, no mínimo, uma chave success:

// Success
return ['success' => true, 'data' => [...]];

// Failure
return ['success' => false, 'message' => 'Human-readable error'];

---

Registar a sua capability

Registe a sua classe usando a ação wu_domain_seller_register_capabilities:

add_action('wu_domain_seller_register_capabilities', function(\WP_Ultimo\Integrations\Integration_Registry $registry) {
    $registry->add_capability('my-registrar', new \My\Plugin\Capabilities\My_Registrar_Selling());
});

O primeiro argumento para add_capability() é o ID do provider — um slug em minúsculas usado para identificar o seu registrar nas definições, na configuração do produto e nos canais de log. Use algo único (por exemplo, o slug da sua empresa).

---

Adicionar campos de credenciais ao assistente

Para permitir que administradores introduzam credenciais através do assistente de configuração, registe a sua integração:

add_action('wu_domain_seller_register_integrations', function(\WP_Ultimo\Integrations\Integration_Registry $registry) {
    $registry->add_integration('my-registrar', [
        'name'   => __('My Registrar', 'my-plugin'),
        'fields' => [
            [
                'id'    => 'my_registrar_api_key',
                'label' => __('API Key', 'my-plugin'),
                'type'  => 'text',
            ],
            [
                'id'    => 'my_registrar_api_secret',
                'label' => __('API Secret', 'my-plugin'),
                'type'  => 'password',
            ],
        ],
    ]);
});

As credenciais são armazenadas como opções de rede usando os IDs dos campos como chaves. Obtenha-as na sua classe de capability com wu_get_setting('my_registrar_api_key').

---

Hooks para ações pós-registo

Use estas ações para acionar webhooks, provisionamento, notificações ou atualizações de CRM:

// After successful domain registration
add_action('wu_domain_registration_completed', function($payment, $registration_data, $result) {
    // $registration_data: domain_name, provider_id, years, expiry_date, customer_id
    // $result: raw registrar response
    my_crm_update_domain($registration_data['domain_name'], $registration_data['customer_id']);
}, 10, 3);

// After registration failure
add_action('wu_domain_registration_failed', function($payment, $registration_data, $error_message) {
    my_alert_team("Domain registration failed: {$registration_data['domain_name']} — {$error_message}");
}, 10, 3);

// After successful renewal
add_action('wu_domain_renewal_completed', function($payment, $renewal_data, $result) {
    // Update your billing system, send a receipt, etc.
}, 10, 3);

// After renewal failure
add_action('wu_domain_renewal_failed', function($payment, $renewal_data, $error_message) {
    // Alert, retry logic, etc.
}, 10, 3);

// After domain transfer completes
add_action('wu_domain_transfer_completed', function($domain, $transfer_data) {
    // $domain is a WP_Ultimo\Models\Domain object
}, 10, 2);

// After SES DKIM verification (if SES integration is active)
add_action('wu_domain_ses_verified', function($domain) {
    // $domain is a WP_Ultimo\Models\Domain object
});

---

Registos

Escreva no seu canal de registo específico do fornecedor usando wu_log_add():

wu_log_add('domain-seller-my-registrar', "Registered {$domain_name} successfully", 'info');
wu_log_add('domain-seller-my-registrar', "Registration failed: {$error}", 'error');

Os registos aparecem em Administração da Rede › Ultimate Multisite › Registos › domain-seller-my-registrar.