Skip to main content

Eng personaliséiert Registrar-Integratioun bauen

Den Domain Seller-Addon benotzt en Integration Registry-Muster. All Registrar ass eng PHP-Klass, déi Domain_Selling_Capability implementéiert a sech selwer iwwer den wu_domain_seller_register_capabilities Action Hook registréiert.

Dëse Guide weist, wéi een e personaliséierte Registrar ubënnt.

D'Interface

Deng Klass muss WP_Ultimo\Integrations\Capabilities\Domain_Selling_Capability implementéieren an WP_Ultimo\Integrations\Base_Capability_Module erweideren.

Erfuerderlech Methoden:

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 { ... }
}

Optional Methoden

Implementéier dës, fir zousätzlech Funktiounen ze spären. Den Addon erkennt Ënnerstëtzung iwwer method_exists():

MethodSpäert fräi
supports_whois_privacy(): boolWHOIS-Privatsphäroptioun an de Produktastellungen
enable_whois_privacy(string $domain_name): arrayAktivéiert Privatsphär automatesch bei der Registréierung
get_dns_records(string $domain_name): arrayDNS-Usiichts-Tab fir Clienten
add_dns_record(string $domain_name, array $record_data): arrayClient ka DNS-Opzeechnunge bäifügen
update_dns_record(string $domain, string $record_id, array $record_data): arrayClient ka DNS-Opzeechnunge änneren
delete_dns_record(string $domain, string $record_id, array $data): arrayClient ka DNS-Opzeechnunge läschen
update_nameservers(string $domain_name, array $nameservers): arrayNameserver-Verwaltung
get_epp_code(string $domain_name): arrayDomain-Iwwerdroung (erausgoend)
transfer_domain(string $domain, string $auth_code, array $registrant_info, array $options): arrayDomain-Iwwerdroung (erakommend)

Konventioun fir de Réckgabewäert

All Methode ginn en Array zréck mat op d'mannst engem success-Schlëssel:

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

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

Deng Capability registréieren

Registréier deng Klass mam wu_domain_seller_register_capabilities Action:

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());
});

Dat éischt Argument fir add_capability() ass d'Provider-ID — e klenge Slug, dee benotzt gëtt, fir däi Registrar an Astellungen, Produktkonfiguratioun a Log-Kanäl z'identifizéieren. Benotz eppes Eenzegaarteges (z. B. de Slug vun denger Firma).


Umeldedonnéeë-Felder an de Wizard bäifügen

Fir Adminnen Umeldedonnéeën iwwer de Setup-Wizard aginn ze loossen, registréier deng Integratioun:

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',
],
],
]);
});

Umeldedonnéeë ginn als Netzwierkoptioune gespäichert, mat de Feld-IDen als Schlësselen. Rëff se an denger Capability-Klass mat wu_get_setting('my_registrar_api_key') of.


Hooks fir Aktiounen no der Registréierung

Benotz dës Actionen, fir Webhooks, Bereetstellung, Notifikatiounen oder CRM-Aktualiséierungen auszeléisen:

// 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
});

Protokolléierung

Schreift an Äre provider-spezifesche Log-Channel mat 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');

Protokoller erschéngen ënner Netzwierk-Admin › Ultimate Multisite › Protokoller › domain-seller-my-registrar.