Atoship
文档
帮助中心GitHub

Postman 集合

下载并使用我们官方的 Postman 集合，快速测试并对接 atoship API。

atoship API 集合
v2.1
可用
完整集合，包含 15 个 API 端点，涵盖最新的 V1 API、鉴权、地址、运费、面单、物流追踪以及物流商管理。
下载集合
端点数量
15 个 API 端点
最近更新
2026-02-18
大小
9.4 KB
格式
Postman v2.1
环境变量
必填
为开发、预发布和生产环境预置的环境变量。
开发环境生产环境
开发环境
http://localhost:3001
本地
生产环境
https://atoship.com/api
线上

快速上手

1. 导入集合

下载 atoship API 集合，并将其导入你的 Postman 工作区。

2. 配置环境

使用我们的环境模板配置你的 API 密钥和基础 URL。

3. 测试端点

用预置的请求和示例开始测试各个 API 端点。

4. 自动化

使用 Newman 或 Postman CLI 在你的 CI/CD 流水线中运行集合。

环境配置

必需变量
在你的 Postman 环境中设置这些环境变量，以便完成鉴权并配置 API 请求。
api_key

你的 atoship API 密钥

ak_test_1234567890abcdef
base_url

API 基础 URL

https://atoship.com/api/v1
environment

环境类型

development | production
timeout

请求超时（毫秒）

30000
环境模板
为不同开发阶段预置的环境配置。

开发环境
本地

{
  "name": "atoship Development",
  "values": [
    {
      "key": "base_url",
      "value": "http://localhost:3001/api",
      "enabled": true
    },
    {
      "key": "api_key",
      "value": "ak_test_1234567890abcdef",
      "enabled": true
    },
    {
      "key": "environment",
      "value": "development",
      "enabled": true
    }
  ]
}

生产环境
线上

{
  "name": "atoship Production",
  "values": [
    {
      "key": "base_url",
      "value": "https://atoship.com/api/v1",
      "enabled": true
    },
    {
      "key": "api_key",
      "value": "ak_live_your_production_key",
      "enabled": true
    },
    {
      "key": "environment",
      "value": "production",
      "enabled": true
    }
  ]
}
配置步骤
配置 Postman 环境的分步指南。
1

导入环境文件

下载环境 JSON 文件，并通过 Postman 的 "Import" 按钮导入。

2

更新 API 密钥

用你在控制台获取的真实 atoship API 密钥替换占位密钥。

3

选择环境

在右上角的环境下拉菜单中，选择刚导入的环境。

4

测试连接

运行一个简单的 GET 请求，验证你的环境配置是否正常工作。

API 覆盖范围

完整的 API 端点覆盖
我们的 Postman 集合覆盖所有可用的 API 端点，并按功能进行归类。

鉴权

V1

用于沙箱和生产环境的 API 密钥管理。

  • • 创建 API 密钥
  • • 列出 API 密钥
  • • 删除 API 密钥

账户

核心

账户设置、余额、用户和物流商。

  • • 获取/更新账户
  • • 余额与交易记录
  • • 用户与团队
  • • 物流商账户（BYOCA）

地址

核心

创建、校验并管理收发货地址。

  • • 创建地址
  • • 校验地址
  • • 获取/列出地址

运费

核心

从多家物流商获取运费报价。

  • • 获取运费报价
  • • 支持 BYOCA 报价
  • • 多物流商比价

面单

热门

创建、管理并下载运输面单。

  • • 创建/获取/列出面单
  • • 物流追踪对接
  • • 作废/退款面单
  • • 保险保障
  • • 费用明细

退货与 Webhook

进阶

退货面单、二维码和事件通知。

  • • 创建退货面单/二维码
  • • Webhook 端点
  • • 实时事件
  • • 理赔管理

集合特性

请求前脚本

自动管理鉴权令牌并对请求进行签名。

测试脚本

内置响应校验和错误处理测试。

示例响应

每个端点都附带真实的 API 响应和示例数据。

错误场景

针对各种错误情况和边界情形的测试用例。

工作流

覆盖常见对接场景的端到端工作流。

文档

每个端点均附带内嵌文档和使用示例。

快速上手工作流

完整发货工作流示例
使用我们预置的请求，测试一套完整的端到端发货流程。

基础流程（5 步）

1
创建/校验地址
POST /v1/addresses
2
获取运费报价
POST /v1/rates
3
创建面单
POST /v1/labels
4
追踪包裹
GET /v1/tracking/:tracking_number
5
配置 Webhook
POST /v1/webhooks

高级功能

批量
批量操作

通过批量 API 同时处理多个发货任务

AI
智能路由

AI 驱动的物流商选择与路线优化

Webhook
实时更新

物流追踪和状态变更的自动通知

退货
退货面单

生成退货面单并管理退货流程

准备好开始测试了吗？

导入我们的集合，按照上面的工作流操作即可

下载集合试用 API Playground
atoship © 2026