Namecheap 域注册员
此包通过"Namecheap XML API"提供代理域可用性检查,注册,账户上市和DNS主机记录管理.
安装
npm install @framers/agentos-ext-domain-namecheap
同伴依赖 : @framers/agentos >=0.10.40。 。 。 .
使用量
import { AgentOS } from '@framers/agentos';
const agentos = await AgentOS.create({
extensionManifest: {
packs: [
{
package: '@framers/agentos-ext-domain-namecheap',
options: {
apiUser: process.env.NAMECHEAP_API_USER,
apiKey: process.env.NAMECHEAP_API_KEY,
userName: process.env.NAMECHEAP_USERNAME,
clientIp: process.env.NAMECHEAP_CLIENT_IP,
useSandbox: process.env.NAMECHEAP_SANDBOX === 'true',
},
},
],
},
});
配置
| 选项 | 秘密编号 | 环境变量 | 需求 | 默认 |
|---|---|---|---|---|
apiUser | namecheap.apiUser | NAMECHEAP_API_USER | 对 | 空字符串 |
apiKey | namecheap.apiKey | NAMECHEAP_API_KEY | 对 | 空字符串 |
userName | namecheap.userName | NAMECHEAP_USERNAME | 没有 | apiUser |
clientIp | namecheap.clientIp | NAMECHEAP_CLIENT_IP | 对 | 空字符串 |
useSandbox | NAMECHEAP_SANDBOX | 没有 | false | |
secrets | 没有 | A. 背景情况 secrets,则 {} | ||
baseUrl (仅服务建筑师) | 没有 | https://api.namecheap.com/xml.response,或 https://api.sandbox.namecheap.com/xml.response 何时 useSandbox 真实 |
从选项中确定身份,然后是选定的秘密地图,然后是环境变量。 沙盒环境变量仅在等同时允许沙盒 true工厂没有通过 baseUrl 服务.
工具
| 工具 | 它会做什么 |
|---|---|
namecheapSearchDomain | 检查逗号分隔的域名,以确定可用性和溢价. |
namecheapRegisterDomain | 购买一个有注册联系人, WhoisGuard 和 nameserver 选项的域. |
namecheapListDomains | 列出具有创建,到期,锁定,续签和WhoisGuard状态的账户域. |
namecheapConfigureDns | 设置 DNS 主机记录,替换域的所有已存在的记录. |
namecheapGetDnsRecords | 检索带有值,TTL,MX优先级和活性状态的 DNS 主机记录. |
namecheapSearchDomain
| 参数 | 类型 | 需求 | 说明 |
|---|---|---|---|
domains | 字符串 | 对 | 要检查的逗号分隔域列表( 如"example.com,example.net,example.io") |
namecheapRegisterDomain
| 参数 | 类型 | 需求 | 说明 |
|---|---|---|---|
domainName | 字符串 | 对 | 要注册的域名( 如"example.com") |
years | 编号 | 没有 | 登记年数(1-10,默认:1) |
registrant | 对象 | 对 | 登记人联系信息: firstName, (中文(简体) ), lastName, (中文(简体) ), address1, (中文(简体) ), city, (中文(简体) ), stateProvince, (中文(简体) ), postalCode, (中文(简体) ), country, (中文(简体) ), phone, (中文(简体) ), emailAddress可选: organizationName, (中文(简体) ), address2。 。 。 . |
registrant.firstName | 字符串 | 对,在 registrant | |
registrant.lastName | 字符串 | 对,在 registrant | |
registrant.address1 | 字符串 | 对,在 registrant | |
registrant.city | 字符串 | 对,在 registrant | |
registrant.stateProvince | 字符串 | 对,在 registrant | |
registrant.postalCode | 字符串 | 对,在 registrant | |
registrant.country | 字符串 | 对,在 registrant | 2- 字母国家代码(例如“美国”、“GB”) |
registrant.phone | 字符串 | 对,在 registrant | 电话为+countryCode格式(如"+1.55555555555") |
registrant.emailAddress | 字符串 | 对,在 registrant | |
registrant.organizationName | 字符串 | 没有 | |
registrant.address2 | 字符串 | 没有 | |
tech | 对象 | 没有 | 技术联系人(形状与 registrant,默认为 registrant(中文(简体) ) |
admin | 对象 | 没有 | 管理员联系人( 形状与 registrant,默认为 registrant(中文(简体) ) |
auxBilling | 对象 | 没有 | AuxBilling 联系人(形状与 registrant,默认为 registrant(中文(简体) ) |
addFreeWhoisguard | 布尔 | 没有 | 启用 Whois 守护隐私( 默认: true) |
wgEnabled | 布尔 | 没有 | 激活 Whois Guard( 默认: 真) |
nameservers | 字符串 | 没有 | 自定义名称服务器, 逗号分隔( 如果省略则使用 Namecheap 默认) |
namecheapListDomains
| 参数 | 类型 | 需求 | 说明 |
|---|---|---|---|
pageSize | 编号 | 没有 | 每页域数( 默认: 20, 最大: 100) |
page | 编号 | 没有 | 要检索的页码( 默认:1) |
namecheapConfigureDns
| 参数 | 类型 | 需求 | 说明 |
|---|---|---|---|
domain | 字符串 | 对 | 完全合格域名(如"example.com") |
records | 对象数组 | 对 | 要设置的 DNS 记录阵列 。 每个记录需要: hostName (例如"@","www"), recordType (单位:千美元)A, (中文(简体) ), AAAA, (中文(简体) ), CNAME, (中文(简体) ), MX, (中文(简体) ), TXT, (中文(简体) ), URL, (中文(简体) ), URL301, (中文(简体) ), FRAME, (中文(简体) ), address (数值). 可选 : mxPref (默认"10"), ttl (默认"1800"). |
records[].hostName | 字符串 | 是的,在每个记录中 | 主机名( 如 root “ @” 、 “ www” 、 “ mail” 、 “ *” 等通配符) |
records[].recordType | 字符串, enum : A, (中文(简体) ), AAAA, (中文(简体) ), CNAME, (中文(简体) ), MX, (中文(简体) ), TXT, (中文(简体) ), URL, (中文(简体) ), URL301, (中文(简体) ), FRAME | 是的,在每个记录中 | DNS 记录类型 |
records[].address | 字符串 | 是的,在每个记录中 | 记录值( IP 地址、 主机名或文本内容) |
records[].mxPref | 字符串 | 没有 | MX偏好/ 优先级( 默认 “ 10 ” , 仅针对 MX 记录) |
records[].ttl | 字符串 | 没有 | 以秒计活的时间( 默认" 1800") |
namecheapGetDnsRecords
| 参数 | 类型 | 需求 | 说明 |
|---|---|---|---|
domain | 字符串 | 对 | 完全合格域名(如"example.com") |
页:1
启动拒绝缺失 apiUser, (中文(简体) ), apiKey 或者说 clientIp 并通过列出域来检查证书。 客户端IP必须被白列于"名厨"仪表板上. 请使用在 URL 中带有认证和命令参数 .
登记向账户余额收取费用。 技术、管理和计费联系人默认为 registrant。Whois Guard 设置默认启用.
DNS 配置替换所有已存在的记录并拒绝空的 records 阵列。 检索记录 namecheapGetDnsRecords 并包括替换组合中保留的记录。 上市工具转发了 pagination 值,而不执行 schema 描述的最大值 。 工具失败返回 success: false 还有一个 error 留言.
许可证
阿帕奇 - 2.0