花生壳开放隧道映射API:支持自动化创建与管理

0 阅读3分钟

对于拥有大量内网服务需要对外映射,或希望将内网穿透能力集成至自有运维平台、物联网管理系统的企业与开发者而言,手动登录花生壳客户端或Web控制台逐一创建、修改映射隧道,不仅效率低下,更难以满足自动化运维的需求。

为了解决这一痛点,花生壳正式开放了映射管理API接口。

通过这套接口,我们可以完全摆脱对图形界面的依赖,使用代码或脚本自动创建、编辑、删除和查询内网穿透隧道,将花生壳强大的穿透能力无缝集成到您的业务流程中。

花生壳映射管理API四大核心功能

创建隧道映射: 通过调用API,动态为新部署的设备或服务生成公网访问地址。无论是HTTP/HTTPS网站、TCP端口服务还是UDP应用,均可通过参数一键创建。

编辑/修改隧道: 当内网服务IP地址变更、端口调整或需要切换映射协议时,无需人工干预,系统可直接调用API实时更新隧道配置。

删除隧道: 在服务下线或测试环境销毁时,通过API及时回收公网端口资源,确保资源有效利用与安全合规。

获取隧道列表与详情: 定期巡检或同步状态,通过API拉取账号下所有隧道的当前状态(如连接状态、流量情况、域名地址),便于集成到您自己的监控大屏中。

如何调用?

花生壳API遵循标准的HTTP/HTTPS协议,返回数据格式为通用的JSON,便于各类编程语言(Python, Java, Go, PHP等)快速解析。其经典调用流程如下:

1、 获取 身份 认证: 调用API前,登录花生壳管理平台 ,进入API keys页面,创建一个新的API Key并获取密钥内容,在后续的所有接口请求中,您都需要在请求头(Header)中带上这个通行证。

基础调用信息 如下

● 请求地址 (Base URL): hsk-api.oray.com

● 认证方式:在 Header 中添加字段Authorization: apikey 您的秘钥

2、 构建请求参数:根据需求(如创建Web映射或TCP映射),组装包含内网主机IP、内网端口、映射协议、带宽限制等信息的JSON数据包。

3、 发送请求并解析结果: 向指定的API端点发送POST/GET请求,根据返回的HTTP状态码和JSON数据判断操作是否成功,并提取生成的公网访问URL。

总之,花生壳映射管理API的开放,不仅赋予了开发者极高的灵活性和扩展性,也让内网穿透不再是独立的操作步骤,而是能够变成应用或是工作流的有部分。

对于追求高效、自动化的现代IT架构而言,这无疑是一项极具价值的效率提升工具。