Download the PHP package hostmyservers/netim-rest_api without Composer
On this page you can find all versions of the php package hostmyservers/netim-rest_api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download hostmyservers/netim-rest_api
More information about hostmyservers/netim-rest_api
Files in hostmyservers/netim-rest_api
Package netim-rest_api
Short Description Client REST API pour Netim par HostMyServers
License MIT
Informations about the package netim-rest_api
HostMyServers Netim REST API Client
A Laravel package to interact with the Netim API for domain management.
Installation
You can install the package via composer:
Configuration
First, publish the configuration file using the following command:
This will create a config/netim.php file in your project.
Add these variables to your .env file:
The published configuration file will automatically use these environment variables.
Basic Usage
Error Handling
The API client throws NetimException when errors occur. You should handle these exceptions in your code:
Session Management
The client automatically handles session creation and cleanup. However, you can manually manage sessions if needed:
Available Methods
Domain Management (DomainService)
getDomainInfo(string $domain): Get domain informationcheckDomain(string $domain): Check domain availabilitycheckDomainClaim(string $domain): Check domain claimscreateDomain(string $domain, array $domainData): Register a new domaintransferDomain(string $domain, array $transferData): Transfer a domain to NetimtransferDomainTrade(string $domain, array $transferData): Transfer and trade a domaininternalTransferDomain(string $domain, array $transferData): Transfer a domain to another Netim accounttransferOwner(string $domain, string $idOwner): Change the owner (holder) of a domain (the new owner contact must have isOwner=1)renewDomain(string $domain, int $period): Renew a domainupdateDNS(string $domain, array $nameservers): Update DNS serverssetWhoisPrivacy(string $domain, bool $enabled): Enable/Disable WHOIS privacysetAutoRenew(string $domain, bool $enabled): Enable/Disable auto-renewalgetWhois(string $domain): Get WHOIS informationdeleteDomain(string $domain): Delete a domaingetDomainsList(): Get list of all domainssetDNSSEC(string $domain, int $enabled): Configure DNSSECsetDNSSECExt(string $domain, array $dnssecData): Configure external DNSSECsetDomainLock(string $domain, string $locked): Update domain lock statusrequestAuthCode(string $domain, int $sendtoregistrant): Request authorization coderestoreDomain(string $domain): Restore an expired domain
Zones Management (ZonesService)
initializeDnsZone(string $domain, array $options): Initialize a DNS zoneinitializeSoaRecord(string $domain, array $options): Initialize SOA recordcreateDnsZone(string $domain, array $records): Create a DNS zonedeleteDnsZone(string $domain, $records): Delete a DNS zonegetDnsRecordsList(string $domain): Get list of DNS recordscreateMailForward(string $domain, string $source, string $destination): Create an email forwarddeleteMailForward(string $domain, string $source): Delete an email forwardgetMailForwardsList(string $domain): Get list of email forwardscreateWebForward(string $domain, string $source, string $destination, array $options): Create a web forwarddeleteWebForward(string $domain, string $source): Delete a web forwardgetWebForwardsList(string $domain): Get list of web forwards
Contact Management (ContactService)
createContact(array $contactData): Create a new contactgetContact(string $contactId): Get contact informationupdateContact(string $contactId, array $contactData): Update a contactdeleteContact(string $contactId): Delete a contactgetContactList(string $field, string $filter): Get filtered list of contacts
Host Management (HostService)
createHost(string $host, array $ipv4, array $ipv6): Create a new host (at least one IP required)getHostsList(string $filter): Get list of hosts matching a filter (wildcard*supported)updateHost(string $host, array $ipv4, array $ipv6): Update a host's IP addressesdeleteHost(string $host): Delete a host (only if no domain uses it)
TLD Services (TldService)
getInfo(string $tld): Get TLD informationgetPriceList(): Get TLD price list
License
This package is open-sourced software licensed under the MIT license.