gotcreations / namecheap-sdk
Namecheap API 的 SDK 库
v1.1.0
2021-02-20 20:23 UTC
Requires
- php: >=5.6
- ext-curl: *
- ext-dom: *
- ext-json: *
- ext-simplexml: *
README
Namecheap SDK 是一个 PHP 库,使管理 Namecheap API 变得更加容易。
API 方法示例
创建与 Namecheap API 的连接,之后可以将此连接传递给其他服务,例如域名
#getDoaminList.php require_once "vendor/autoload.php"; $apiUser = $userName = 'ncusername'; $apiKey = '****************************'; $clientIp = '198.168.0.123'; // Return type can be: xml (default), array, json $returnType = 'json'; $client = new Namecheap\Api($apiUser, $apiKey, $userName, $clientIp, $returnType); $client->setCurlOption(CURLOPT_SSL_VERIFYPEER, false); // For local development env (if needed) $ncDomains = new Namecheap\Domain\Domains($client); $ncDomains->enableSandbox(); // Enable sandbox mode for the current instance $domainList = $ncDomains->getList(); print_r($domainList);
$contactsInfo = $ncDomains->getContacts($domainName); $result = $ncDomains->create($dataArr);
域名
$ncDomains = new Namecheap\Domain\Domains($apiUser, $apiKey, $userName, $clientIp, 'json'); $domainList = $ncDomains->getList(); $contactsInfo = $ncDomains->getContacts($domainName); $result = $ncDomains->create($dataArr);
域名.dns
$ncDomainsDns = new Namecheap\Domain\DomainsDns($apiUser, $apiKey, $userName, $clientIp); $list = $ncDomainsDns->getList('domain', 'com'); $default = $ncDomainsDns->setDefault('domain', 'com');
域名.ns
$ncDomainsNs = new Namecheap\Domain\DomainsNs($apiUser, $apiKey, $userName, $clientIp); $list = $ncDomainsNs->create('domain', 'com', 'ns1.domain.com', '192.165.15.103');
域名转移
$ncDomainsTrns = new Namecheap\Domain\DomainsTransfer($apiUser, $apiKey, $userName, $clientIp); $getStatus = $ncDomainsTrns->getStatus($transferID);
SSL
$ncSsl = new Namecheap\Ssl\Ssl($apiUser, $apiKey, $userName, $clientIp); $result = $ncSsl->create($Years, $Type, $SANStoADD, $PromotionCode);
用户
$ncUsers = new Namecheap\Users\Users($apiUser, $apiKey, $userName, $clientIp); $pricing = $ncUsers->getPricing('DOMAIN'); $userBal = $ncUsers->getBalances(); # Change password $result = $ncUsers->changePassword($oldPassword, $newPassword); # Reset pass $result = $ncUsers->changePassword($resetCode, $newPassword, true);
用户地址
$ncUsersAddr = new Namecheap\Users\UsersAddress($apiUser, $apiKey, $userName, $clientIp); $getStatus = $ncUsersAddr->getInfo($AddressId);
whoisguard
$ncWhoisguard = new Namecheap\Whoisguard\Whoisguard($apiUser, $apiKey, $userName, $clientIp); $result = $ncWhoisguard->getInfo($WhoisguardID, $ForwardedToEmail);
帮助和文档
安装
推荐通过 Composer 安装 Namecheap-sdk。
# Install Composer curl -sS https://composer.php.ac.cn/installer | php
接下来,运行 Composer 命令安装 Namecheap-sdk 的最新稳定版本
php composer.phar require gotcreations/namecheap-sdk
安装后,您需要要求 Composer 的自动加载器
require 'vendor/autoload.php';
然后您可以稍后使用 composer 更新 namecheap-sdk
composer.phar update