猪群域登记员
这个包通过"猪笼草"(Porkbun REST API)提供了代理域的可用性检查,购买,账户列表,DNS管理和转账.
安装
npm install @framers/agentos-ext-domain-porkbun
同伴依赖 : @framers/agentos >=0.10.40。 。 。 .
使用量
import { AgentOS } from '@framers/agentos';
const agentos = await AgentOS.create({
extensionManifest: {
packs: [
{
package: '@framers/agentos-ext-domain-porkbun',
options: {
apiKey: process.env.PORKBUN_API_KEY,
secretApiKey: process.env.PORKBUN_SECRET_API_KEY,
},
},
],
},
});
配置
| 选项 | 秘密编号 | 环境变量 | 需求 | 默认 |
|---|---|---|---|---|
apiKey | porkbun.apiKey | PORKBUN_API_KEY | 对 | 空字符串 |
secretApiKey | porkbun.secretApiKey | PORKBUN_SECRET_API_KEY | 对 | 空字符串 |
secrets | 没有 | A. 背景情况 secrets,则 {} | ||
baseUrl (仅服务建筑师) | 没有 | https://api.porkbun.com/api/json/v3 |
从选项中确定身份,然后是选定的秘密地图,然后是环境变量。 工厂没有通过 baseUrl 服务.
工具
| 工具 | 它会做什么 |
|---|---|
porkbunSearchDomain | 检查域可用性并检索定价. |
porkbunRegisterDomain | 使用已提供的联系人或账户默认来购买域 . |
porkbunListDomains | 列出日期,状态,锁定,隐私和更新设置的账户域. |
porkbunConfigureDns | 添加,删除,列出或更新 DNS 记录. |
porkbunTransferDomain | 使用授权代码启动向宝克本的转移 . |
porkbunSearchDomain
| 参数 | 类型 | 需求 | 说明 |
|---|---|---|---|
domain | 字符串 | 对 | 要检查的域名( 如"example.com","coolsite.dev") |
porkbunRegisterDomain
| 参数 | 类型 | 需求 | 说明 |
|---|---|---|---|
domain | 字符串 | 对 | 要注册的域名( 如"example.com") |
years | 编号 | 没有 | 注册年数( 默认:1, 最多: 10) |
firstName | 字符串 | 没有 | 注册名( 如果省略则使用账户默认) |
lastName | 字符串 | 没有 | 注册名( 如果省略则使用账户默认) |
email | 字符串 | 没有 | Registrant 电子邮件( 如果省略则使用账户默认) |
phone | 字符串 | 没有 | Registrant 电话号码( 如果省略则使用账户默认) |
city | 字符串 | 没有 | 注册城市( 如果省略则使用账户默认) |
state | 字符串 | 没有 | Registrant 状态/ 省( 如果省/ 省使用账户默认) |
zip | 字符串 | 没有 | Registrant 邮政编码( 如果省略则使用账户默认) |
country | 字符串 | 没有 | Registrant country 代码, 如 “ US ” ( 如果省略则使用账户默认) |
organization | 字符串 | 没有 | 登记组织(可选) |
address | 字符串 | 没有 | Registrant 街道地址( 如果省略则使用账户默认) |
porkbunListDomains
输入方案没有参数.
porkbunConfigureDns
| 参数 | 类型 | 需求 | 说明 |
|---|---|---|---|
domain | 字符串 | 对 | 域名 (如"example.com") |
action | 字符串, enum : add, (中文(简体) ), remove, (中文(简体) ), list, (中文(简体) ), update | 没有 | 要执行的行动( 默认: 列表) |
recordId | 字符串 | 没有 | DNS 记录ID( 需要删除和更新动作) |
type | 字符串, enum : A, (中文(简体) ), AAAA, (中文(简体) ), CNAME, (中文(简体) ), TXT, (中文(简体) ), MX, (中文(简体) ), NS, (中文(简体) ), SRV, (中文(简体) ), TLSA, (中文(简体) ), CAA, (中文(简体) ), ALIAS | 没有 | DNS 记录类型( 需要添加动作) |
name | 字符串 | 没有 | 子域名或记录名(如"www","mail"). 空字符串或为根域省略. |
content | 字符串 | 没有 | 记录值/内容(如IP地址,主机名,TXT值) |
ttl | 字符串 | 没有 | 以秒计活的时间( 默认为" 300" ) |
prio | 字符串 | 没有 | 优先权(MX记录需要,其他人可以选择) |
porkbunTransferDomain
| 参数 | 类型 | 需求 | 说明 |
|---|---|---|---|
domain | 字符串 | 对 | 要传输的域名( 如"example.com") |
authCode | 字符串 | 对 | 现任登记员的授权/EPP代码(授权转让的必要条件) |
页:1
激活拒绝缺失的证书,并通过API ping端点认证. API 密钥来自 https://porkbun.com/account/api。请求使用 POST 与 apikey 财务报告和审定财务报表 secretapikey 在体内.
登记向档案上的支付方法收费。 联系字段在省略时使用账户默认值 。 传输提交域和授权代码;工具描述要求域由上任登记员解锁.
DNS更改创建,编辑或删除记录. 需要增加 type 财务报告和审定财务报表 content; 需要删除和更新 recordId。更新后检索记录并返回匹配记录,或者在找不到匹配时返回完整列表。 定价的检查失败使定价没有结果。 工具失败返回 success: false 还有一个 error 留言.
许可证
阿帕奇 - 2.0