阅读时间： 5 分钟

舰队平台
移动应用程序

构建自定义集成
使用 Zeo API

使用我们的 RESTful API 将您的系统连接到 Zeo。创建路由，
实时跟踪进度，并使用 Webhook 实现工作流程自动化。

查看 API 文档

获取API密钥

99.9%

API 正常运行时间 SLA
100ms

平均响应时间
20+

API端点
10

每分钟请求次数限制

开发者平台产品特性

将路线规划集成到您的应用程序中所需的一切

开始免费试用

REST API

功能齐全的 RESTful API，用于管理路线、站点、司机等。采用 JSON 请求/响应格式，并附有详尽的文档。
- 以编程方式创建和优化路线
- 管理站点、司机和车辆
- 获取实时跟踪数据
- 访问分析和报告
- 批量操作支持
Webhook 事件

实时事件通知推送至您的端点。立即响应路由变更、停止完成和驱动程序更新。
- 路线开始/完成事件
- 停止状态更改通知
- 驾驶员位置更新
- 预计到达时间变更提醒
认证

采用行业标准身份验证，确保 API 访问安全。提供多种密钥类型，以满足不同的访问级别和使用场景。
- Bearer令牌认证
- API密钥管理控制面板
- 每个密钥的权限范围
- 关键轮换支持
- 每个按键的速率限制
第三方进口

无缝导入外部系统中的订单和作业。导入时自动进行地址验证和地理编码。
- 批量停止导入端点
- 地址验证和地理编码
- 自定义字段映射
- 重复检测
- 导入状态跟踪

网络挂接活动

订阅实时事件并对路线变更做出即时反应

路线已启动

当驾驶员开始导航路线时触发。包含路线 ID、驾驶员信息和预计完成时间。

停止完成

当站点标记为完成时触发。包含服务证明数据、时间戳和备注。

停止失败

当停靠任务未能完成时发送。包含失败原因以及任何已拍摄的照片/备注。

驱动程序位置更新

定期更新活跃驾驶员的位置信息。更新频率可配置，范围从 30 秒到 5 分钟。

eta.已更改

当预计到达时间因交通或延误而发生显著变化时触发。

路线已完成

当所有站点都完成后触发。包含最终统计数据、持续时间和性能指标。

// Webhook 有效负载示例
{
  “事件”: “停止完成”,
  “时间戳”: "2024-01-15T14:32:00Z",
  “数据”{
    "route_id": "route_abc123",
    "stop_id": "stop_xyz789",
    “司机”{
      “ID”: “drv_456”,
      “名称”: 约翰·史密斯
    },
    “完成于”: "2024-01-15T14:31:45Z",
    “证明”{
      “签名”: "https://...",
      “相片”["https://..."],
      “笔记”: “留在门口”
    } } }

API端点概述

路线规划和车队管理的核心端点

解决方案&帖子

/v1/路由

创建包含停靠点和优化设置的新路线

的GET

/v1/routes/{id}

获取路线详情，包括优化后的顺序

解决方案&帖子

/v1/routes/{id}/优化

使用更新后的参数重新优化现有路线

的GET

/v1/routes/{id}/tracking

获取当前路线的实时跟踪数据

解决方案&帖子

/v1/停止/导入

停止从外部系统批量导入

PUT

/v1/stops/{id}/status

更新停止状态（已完成、失败、已跳过）

的GET

/v1/驱动程序

列出所有可用状态的司机

的GET

/v1/drivers/{id}/location

获取当前位置和路线进度

解决方案&帖子

/v1/webhooks

注册用于事件通知的 webhook 端点

代码例子

通过您喜爱的语言的示例快速入门

创建并优化包含多个停靠点的路线
常量 创建路由 = 异步 () => {
  常量 响应 = 等待 拿来（'https://api.zeoroute.com/v1/routes'， { 方法： 'POST'，标题：{
      '授权': `持有者 ${process.env.ZEO_API_KEY}`,
      '内容类型': '应用程序/json'
    }, body: JSON.stringify({ name: “早间送货”, driver_id: 'drv_123'， 优化： true，起始位置：{地址： “123 Warehouse St, City”
      }，停止：[{地址： “顾客大道456号”，时间窗口：{开始： '09：00'， 结尾： '12：00' }, service_time: 15
        }， { 地址： “789 商业大道”， 优先事项： '高的'服务时间： 30
        } ] }) });

  常量 路线 = 等待 response.json(); console.log('优化路线：'，route.optimized_sequence);
  回报 路线; };

创建并优化包含多个停靠点的路线
进口 要求
进口 os API_KEY = os.environ.get('ZEO_API_KEY') BASE_URL = 'https://api.zeoroute.com/v1'

标头= {
    '授权': f'Bearer {API_KEY}',
    '内容类型': '应用程序/json'
} route_data = {
    “名称”: “早间送货”,
    'driver_id': 'drv_123',
    '优化': 真,
    'start_location'{
        '地址': “123 Warehouse St, City”
    },
    ‘停止’: [ {
            '地址': “顾客大道456号”,
            'time_window'{'开始': '09：00', '结尾': '12：00'},
            'service_time': 15
        }, {
            '地址': “789 商业大道”,
            '优先事项': '高的',
            'service_time': 30
        } ] } response = requests.post(
    f'{基本网址}/路由', headers=headers, json=route_data ) route = response.json() print('优化路线：'， 路线['优化序列'])

创建并优化包含多个停靠点的路线
卷曲 -X POST "https://api.zeoroute.com/v1/routes" -H “授权：持有者 $ZEO_API_KEY” -H “内容类型：应用程序/json” -d '{ "name": "早间配送", "driver_id": "drv_123", "optimize": true, "start_location": { "address": "123 Warehouse St, City" }, "stops": [ { "address": "456 Customer Ave", "time_window": { "start": "09:00", "end": "12:00"}, "service_time": 15 }, { "address": "789 Business Blvd", "priority": "high", "service_time": 30 } ] }'

# 获取路线详情
curl -X GET "https://api.zeoroute.com/v1/routes/route_abc123" -H “授权：持有者 $ZEO_API_KEY”

# 更新停止状态
卷曲 -X PUT "https://api.zeoroute.com/v1/stops/stop_xyz789/status" -H “授权：持有者 $ZEO_API_KEY” -H “内容类型：应用程序/json” -d '{"status": "已完成", "notes": "已放在门口"}'