# Vehicle_Protocol_SDK

**Repository Path**: Foorir/Vehicle_Protocol_SDK

## Basic Information

- **Project Name**: Vehicle_Protocol_SDK
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: dev-001
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-01-25
- **Last Updated**: 2024-01-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 车载主机M20通信协议

## 一、协议简述

- 车载主机使用HTTP POST方式上传

## 二、协议详解

### 2.1 签名

- 文件名+随机数组成待签名字符串
- 将待签字符串进行HmacSHA1 签名得到base64签名字符串sign

例：

- 签名密钥为：rtqewrqer65erqewrq134

- 上传文件文件名：20230211111111.txt
- 随机数：6985742

​	文件名+随机数组成待签名字符串：20230211111111.txt6985742

​	base64 sign字符串：6QV/SFXBWXE5Zzvai1Hy+BQoQ6k=

### 2.2请求参数

- #### Header 请求参数

| 参数名 |    参数值（示例）     | 是否必填 | 参数类型 | 描述说明 |
| :----: | :-------------------: | :------: | :------: | :------: |
| secret | rtqewrqer65erqewrq134 |    是    |   Text   | 签名密钥 |

- #### Body 请求参数

| 参数名 |        参数值（示例）        | 是否必填 |  参数类型  | 描述说明 |
| :----: | :--------------------------: | :------: | :--------: | :------: |
|  file  |          [文件路径]          |    是    | [文件类型] |   文件   |
|  sign  | 6QV/SFXBWXE5Zzvai1Hy+BQoQ6k= |    是    |    Text    |   签名   |
| nonce  |           6985742            |    是    |    Text    |  随机数  |

- #### 响应示例

  成功 (200)

  ```json
  {
  	"retCode": 0,
  	"message": "success"
  }
  ```

  | 参数名  | 参数值（示例） | 是否必填 | 参数类型 |      描述说明       |
  | :-----: | :------------: | :------: | :------: | :-----------------: |
  | retCode |       0        |    是    |  Number  | 0、成功，其他：失败 |
  | message |    success     |    是    |  String  |                     |

  失败 (201)

  ```json
  {
  	"retCode": 101
  	"message": "Signature failure"
  }
  ```

  | 参数名  | 参数值（示例） | 是否必填 | 参数类型 |      描述说明       |
  | :-----: | :------------: | :------: | :------: | :-----------------: |
  | retCode |      101       |    是    |  Number  | 0、成功，其他：失败 |
  | message |    success     |    是    |  String  |                     |

### 2.3 路径

根据平台情况而定，设备本身支持自己设置路径