当前入口用于下游平台和 Agent 对接。
所有业务接口仍通过
X-Platform-Key 保护;真实开通、续费和改密可能产生费用,必须单独授权后才执行。OpenAPI 来源:/docs/openapi.json。
OpenAPI
--
规范版本
接口数量
--
按 method + path 统计
鉴权
Key
Header: X-Platform-Key
联调环境
Prod / Sandbox
先查询,后小额变更
接入流程图
推荐顺序
1. 鉴权所有请求携带
X-Platform-Key,不同环境使用不同域名和密钥。2. 查资源读取资源列表,按国家、城市、类型和价格决定可售 SKU。
3. 查价格开通前先查价,确认平台价、成本口径和可用性。
4. 下单/续费写操作必须带幂等键;批量请求先小量验证再放大。
5. 查实例使用
instance_ref 查询、续费、改密和按需查密。最小调用链
先 Sandbox 后生产
开通
GET /v1/resources选择资源。GET /v1/resources/{resource_id}/pricing确认价格。POST /v1/orders创建订单。GET /v1/orders/{order_no}查询交付结果。
实例维护
GET /v1/instances查询实例。POST /v1/instances/{instance_ref}/renew续费。POST /v1/instances/{instance_ref}/credentials改密。POST /v1/instances/{instance_ref}/credentials/reveal受控查密。
接口总览
等待加载
| 方法 | 路径 | 用途 | 分组 | 幂等 / 批量 |
|---|---|---|---|---|
| 等待加载 OpenAPI | ||||
curl 示例
示例使用占位 API Key
等待加载 OpenAPI...
联调顺序
真实扣费需确认
1. 定价查询先跑
GET /v1/resources/{id}/pricing,保存返回的 quote_id 和 expires_at;查询不触发开通扣费。2. 小额开通确认余额和成本预算后,再跑
POST /v1/orders 和 POST /v1/batches/orders。CNY 平台必须提交未过期的报价锁,所有写操作必须带幂等键。3. 续费和改密只对测试开通出来的实例执行
/renew、/credentials,并检查订单、实例和批次结果。4. 批量标识批量续费和批量改密优先使用
instance_refs,不需要也不应该保存 ProxyCore 内部数字 ID。5. 分页限制
GET /v1/orders 和 GET /v1/instances 支持 limit/offset,默认 20,最大 100。6. 环境边界
sandbox.proxycore.org 与生产库隔离;生产充值由 ProxyCore 后台人工入账或商务流程处理,公开充值接口仅用于 sandbox/demo 验收。7. 暂不支持释放/退订、Webhook、自助 API Key 轮换暂不作为当前公开能力;实例到期和批次进度请通过查询接口轮询。
8. 结算币种金额以
amount / currency、unit_price / currency 等通用字段为准;*_usd 仅在 USD 平台返回。CNY 金额最多精确到分。