客户API快速入门:在一个循环中集成Accplanet /api/v2
如果您以编程方式在 Accplanet 上购买,则无需为每个操作使用不同的 API。客户 API 使用一个端点 — POST https://accplanet.com/api/v2 — 以及一个 action 参数。本指南是一个实用的快速入门,让开发人员可以在一次会话中列出目录项、检查库存、下订单并轮询状态。
Accplanet 是一个供应商聚合市场。供应商履行库存;Accplanet 提供发现、结账、订单跟踪和支持。仅将 API 用于合法的订单管理。完整参考:客户 API 文档。
简介
- 所有客户调用都发送到
POST /api/v2(无/en/前缀),并带有key/apikey+action。 - 典型路径:
balance→categories/shops/services→inventory→add→status。 - 发送
application/x-www-form-urlencoded或 JSON。切勿将密钥放在 URL 或前端代码中。 - 遵守
available、min/max、钱包余额以及 HTTP429/Retry-After。 - 集成时保持实时文档打开 — 字段细节可能随目录演变。
认证和端点
从您的 Accplanet 个人资料 API 密钥页面创建或复制您的客户 API 密钥,然后调用:
POST https://accplanet.com/api/v2
{
"key": "YOUR_API_KEY",
"action": "categories"
}
支持的操作:categories、shops、services、inventory、add、status、balance。
集成阶梯
在继续之前,请确保每个步骤都返回干净的响应。
1 · 首先
确认余额
action=balance 返回钱包 balance 和 currency(USD)。如果余额无法覆盖测试订单,请在仪表板中充值。
2 · 推荐
发现目录结构
action=categories 返回父类别和子类别名称。稍后将这些确切的字符串用作 services 上的 category / subcategory 过滤器。
action=shops 列出公开的供应商商店。当您只想查看一个店面时,将商店的 shop ObjectId 传入 services。
3 · 推荐
列出服务(产品)
action=services 返回可销售项目,包含 service ID、rate、stock、available、min/max 以及可选过滤器(shop、category、entityType、sort、language、分页)。下单前优先选择 available=true 且库存满足 min 的项目。
4 · 推荐
重新检查库存
action=inventory 使用一个 service ID 或逗号分隔的 ID(最多 50 个)确认实时库存。在热门 SKU 上 add 之前非常有用。
5 · 下单并跟踪
添加订单,然后轮询状态
action=add 使用 service 和 quantity 从钱包扣款并返回 order、charge、currency(HTTP 201)。使用该 order ID 轮询 action=status 以获取进度,并在完成时获取交付的有效负载。
| 操作 | 任务 | 必填字段 |
|---|---|---|
balance |
钱包检查 | key |
categories / shops |
发现 | key |
services |
目录 + 定价 | key(+ 可选过滤器) |
inventory |
库存快照 | key、service |
add |
创建订单 | key、service、quantity |
status |
履行状态读取 | key、order |
复制粘贴 curl 示例
# 余额
curl -X POST https://accplanet.com/api/v2 -d "key=YOUR_API_KEY" -d "action=balance"
# 服务页面
curl -X POST https://accplanet.com/api/v2 \
-d "key=YOUR_API_KEY" -d "action=services" -d "page=1" -d "limit=50"
# 库存
curl -X POST https://accplanet.com/api/v2 \
-d "key=YOUR_API_KEY" -d "action=inventory" -d "service=10042"
# 添加订单
curl -X POST https://accplanet.com/api/v2 \
-d "key=YOUR_API_KEY" -d "action=add" -d "service=10042" -d "quantity=1"
# 状态
curl -X POST https://accplanet.com/api/v2 \
-d "key=YOUR_API_KEY" -d "action=status" -d "order=YOUR_ORDER_ID"
将占位符替换为您的密钥、来自 services 的真实 service 以及 add 返回的 order。从低成本测试项目的数量 1 开始。
错误和速率限制
- 无效凭据 → HTTP
401,带有{"error":"Invalid API key"}。 - 验证 / 库存 / 余额问题 → 通常为 HTTP
400,带有单个error字符串(例如库存不足或余额不足)。 - 速率限制 → HTTP
429,带有Retry-After。退避并重试。 - 分页时默认服务页面大小为 50;仅在有意获取完整列表时使用
limit=0。
定价、库存和可用性随实时列表而变化。在自动购买之前始终重新读取 services / inventory。
买家清单
- [ ] API 密钥存储在服务器密钥管理器中
- [ ]
balance足以支付一个小型测试订单 - [ ] 选择了
available=true的service - [ ] 数量在
min/max范围内 - [ ] 持久化了
add返回的orderID 并轮询status - [ ] 在代码中处理了
429和钱包错误
下一步:打开客户 API 文档,运行一次测试 API,然后将相同的操作接入您的后端。集成目录同步的供应商应阅读 Accplanet 博客上的配套供应商指南。
常见问题
路径是否带有语言前缀?
不。使用 https://accplanet.com/api/v2 — 而不是 /en/api/v2。
下单时什么标识产品?
services 中的 service 字段(分配时为数字目录 ID,否则为系统字符串)。将相同的值传递给 inventory 和 add。
我可以按商店或类别过滤吗?
可以。按照客户 API 页面上的文档,使用 categories 中的名称和 shops 中的 shop ObjectId。