Omnilance extends Registrar
Table of Contents
Constants
- BASE_ENDPOINT = 'https://api.omnilance.com/v3/'
- Base endpoint url.
Methods
- __construct() : mixed
- Omnilance constructor.
- checkDomain() : bool|null
- Checks domain available.
- createDomain() : bool|null
- Creates new domain.
- getDomainsList() : array<string|int, mixed>|null
- Returns domain's list.
- renewDomain() : bool|null
- Renews exists domain.
- suggestDomain() : array<string|int, mixed>|null
- Suggests domains by query words.
- updateDns() : bool|null
- Updates domain DNS.
Constants
BASE_ENDPOINT
Base endpoint url.
public
mixed
BASE_ENDPOINT
= 'https://api.omnilance.com/v3/'
Methods
__construct()
Omnilance constructor.
public
__construct(string $apiKey, string $secretKey) : mixed
Parameters
- $apiKey : string
-
API key.
- $secretKey : string
-
Secret key.
checkDomain()
Checks domain available.
public
static checkDomain(string $user, string $password, string $domain, string|null &$error) : bool|null
Parameters
- $user : string
-
User name.
- $password : string
-
User password.
- $domain : string
-
Domain name.
- $error : string|null
-
Error message if occurred.
Return values
bool|null —Returns true if domain exists.
createDomain()
Creates new domain.
public
static createDomain(string $user, string $password, string $domain, array<string|int, mixed> $params, string|null &$error) : bool|null
Parameters
- $user : string
-
User name.
- $password : string
-
User password.
- $domain : string
-
Domain name.
- $params : array<string|int, mixed>
-
Additional params.
- $error : string|null
-
Error message if occurred.
Return values
bool|null —Returns true on success.
getDomainsList()
Returns domain's list.
public
static getDomainsList(string $user, string $password, string|null &$error) : array<string|int, mixed>|null
Parameters
- $user : string
-
User name.
- $password : string
-
User password.
- $error : string|null
-
Error message if occurred.
Return values
array<string|int, mixed>|nullrenewDomain()
Renews exists domain.
public
static renewDomain(string $user, string $password, string $domain, string|null &$error) : bool|null
Parameters
- $user : string
-
User name.
- $password : string
-
User password.
- $domain : string
-
Domain name.
- $error : string|null
-
Error message if occurred.
Return values
bool|null —Returns true on success.
suggestDomain()
Suggests domains by query words.
public
static suggestDomain(string $user, string $password, string $word1, string $word2, array<string|int, mixed> $tlds, string|null &$error) : array<string|int, mixed>|null
Parameters
- $user : string
-
User name.
- $password : string
-
User password.
- $word1 : string
-
Query word 1.
- $word2 : string
-
Query word 2.
- $tlds : array<string|int, mixed>
-
Query tlds.
- $error : string|null
-
Error message if occurred.
Return values
array<string|int, mixed>|nullupdateDns()
Updates domain DNS.
public
static updateDns(string $user, string $password, string $domain, array<string|int, mixed> $params, string|null &$error) : bool|null
Parameters
- $user : string
-
User name.
- $password : string
-
User password.
- $domain : string
-
Domain name.
- $params : array<string|int, mixed>
-
Additional params.
- $error : string|null
-
Error message if occurred.
Return values
bool|null —Returns true on success.