openmaraude/minimal_operateur_server

minimal_operateur_server

镜像概述和主要用途

本镜像为api.taxi注册框架中的操作员服务器示例。获得授权的出租车运营商需部署此类API，以处理行程请求。当api.taxi注册中心收到行程请求时，会向操作员API发送请求，操作员需通知出租车接受或拒绝行程，并更新行程状态。

核心功能和特性

• 接收api.taxi注册中心发送的行程请求
• 验证并处理行程请求数据
• 返回HTTP/200响应确认请求接收
• 异步通知出租车行程请求
• 异步更新行程状态至api.taxi注册中心（包括接收、接受、拒绝状态）

使用场景和适用范围

适用于需要接入api.taxi平台的出租车运营商，作为集成api.taxi行程请求处理功能的基础示例。可帮助运营商快速理解与api.taxi注册中心的交互流程，进而开发符合自身需求的完整解决方案。

详细使用方法和配置说明

配置步骤

1. 编辑settings.py文件，在API_TAXI_KEY变量中填入你的API令牌
2. 若在开发环境中运行，需修改API_TAXI_URL变量为https://dev.api.taxi

启动方法

使用以下命令启动容器：

bash
docker-compose up

功能详细说明

行程请求处理流程

1. 在api.taxi管理控制台的我的账户部分，配置操作员API的行程接受端点URL
2. 当api.taxi注册中心收到行程请求时，会向配置的端点发送POST请求，请求 payload 格式如下：

json
{
    "data": [{
        "customer_lon": <客户经度>,
        "customer_lat": <客户纬度>,
        "customer_address": <客户地址>,
        "customer_phone_number": <客户电话号码>,
        "id": <行程标识符（也称为"hail"）>,
        "taxi": {
            "id": <出租车标识符>
        }
    }]
}

3. 操作员服务器需执行以下操作：
   • 返回HTTP/200响应，确认请求已成功接收
   • 通知目标出租车行程请求
   • 通过异步任务调用api.taxi的PUT /hails/:id端点更新行程状态：
     • 需在10秒内将状态更新为received_by_taxi（未及时更新则行程自动取消）
     • 若出租车接受行程：更新状态为accepted_by_taxi，并在请求中提供taxi_phone_number（出租车电话号码）
     • 若出租车拒绝行程：更新状态为declined_by_taxi
     • 需在30秒内完成最终状态更新（未及时更新则行程自动取消）

限制

本示例服务器默认接受所有行程，仅作为简单且带注释的API示例。用户需自行实现出租车行程请求的通知逻辑，以满足实际业务需求。

使用的模块

• flask：轻量级Python Web框架，用于构建API应用
• marshmallow：用于验证API接收的请求参数
• rq 和 flask-rq2：用于处理异步任务，出租车行程通知及状态更新操作由worker进程异步执行

更多详细信息，请参考api.taxi管理控制台的文档。