饿了么开放平台接口稳定性治理指南
《开放平台应用稳定性管理规范》已于2022年6月份发布公式,并在2022年8月1日正式生效,为提高开放平台的接口稳定性,保障业务稳定进行,开发者可参考此文档治理提升接口稳定性。
稳定性数据分析
开放品台已上线稳定性数据大盘功能,开发者可从应用、场景、接口等维度查看稳定性数据情况,并可对稳定性进行分析,查看调用失败场景的分布情况。
功能入口:【管理中心】-【监控中心】
功能介绍
● 稳定性大盘:查看各应用以及应用下各个场景的稳定性情况
● 稳定性分析:可分析每个场景下调用失败TOP的接口,以及调用失败的TOP应用
● 核心场景稳定性查询:查询应用场景的稳定性趋势
● 接口稳定性查询:查询单个接口的稳定性趋势,以及分析接口下调用失败的TOP场景
错误码治理
常见错误码
一个API调用可能会返回两种错误码,一种是通用的错误码,一种是业务错误码,具体区别如下:
● 通用错误码:例如权限不足,超过访问频次等错误信息,每个接口都会有的固定的错误码;
● 业务错误码:每个接口特有的业务错误码,通过错误码可以得到接口业务异常信息。
通用错误码治理
通用错误码 | 错误说明 | 如何解决 |
---|---|---|
ILLEGAL_REQUEST | 无效请求,请求协议不对 | 使用SDK辅助开发或者根据文档协议将请求体修改正确 |
UNAUTHORIZED | token认证失败 | 检查token是否失效,是否用错,刷新或者重新获取token |
ACCESS_DENIED | 拒绝访问,一般是应用未上线,不允许访问生产环境资源 | 完成应用开发后提交应用进行审核 |
METHOD_NOT_ALLOWED | 禁止访问,一般是没有访问接口/数据的权限 | 检查请求的接口参数是否正确;检查该接口是否在开放平台设置的接口权限范围内 |
PERMISSION_DENIED | 越权访问 | 一般是获取非商户可管理的店铺/订单等资源,检查请求参数是否正确 |
EXCEED_LIMIT | 超出接口访问的频次限制 | 优化程序,使用合理的频次访问开放平台的接口 |
INVALID_SIGNATURE | 签名错误 | 使用SDK进行签名计算或者检查签名算法,尤其注意检查参数名、参数类型是否跟文档标识一致 |
INVALID_TIMESTAMP | 时间戳异常 | 检查请求访问时的时间是否无误 |
VALIDATION_FAILED | 参数校验失败 | 检查参数值、参数名、参数类型是否正确 |
SERVER_ERROR | 系统问题,API服务器异常 | 请稍后重试 |
UNKNOW_ERROR | 未知错误 | 建议请登录开放平台使用小工具查看确认下日志信息 |
业务错误码治理
业务错误码 | 错误说明 | 如何解决 |
---|---|---|
ALREADY PROCESSED ERROR | 重复回复已经回复的评价 | 请勿再回复该评价 |
FAILED_TO_GET_USER_INFORMATION | 获取用户信息失败 | 请检查用户登录信息并重试 |
UNSUPPORTED_ACTIVITY_TYPE | 不支持的活动类型 | 请检查活动类型是否正确 |
REACH_MAX_COUPON_ACTIVITY | 无法创建新的代金券活动 | 未开始和进行中的代金券活动数量已达上限,无法再创建 |
BIZ_IMG_CONTAIN_OTHER_COMPETITOR_EXCEPTION | 图片中含有其他外卖平台信息/不允许上传,请更换 | 请更换或修正图片 |
BIZ_RESTAURANT_NOT_FOUND | 店铺不存在 | 检查店铺ID是否正确 |
BIZ_INVALID_RESTAURANT_GEOMETRY | 非法的配送范围多边形 | 检查提交的配送范围多边形坐标,是否有重叠 |
BIZ_INVALID_LAT_LON | 非法的经纬度值 | 检查提交的经纬度值是否有效 |
BIZ_FAILED_ORDER_STATE | 操作失败,订单已确认;操作失败,订单已取消;操作失败,订单已完结;操作失败,退单处理中 | 请调用正确的接口 |
BIZ_OPERATION_FAILED | 操作失败 | 请调用正确的接口 |
BIZ_ALREADY_CANCELED_EXCEPTION | 订单已取消 | 可以调用订单详情接口查看订单状态,根据订单状态选择对应的操作 |
BIZ_ORDER_NOT_EXIST | 订单不存在 | 请输入正确的订单号 |
BIZ_SERVICE_FAILED | 业务异常 | 建议请登录开放平台使用小工具查看确认下日志信息,确认后重试 |
BIZ_CALL_DELIVERY_FAILED | 呼叫配送失败 | 检查是否为自配送商家,并调用正确接口 |
BIZ_UPDATE_FOOD_FAILED_EXCEPTION | 更新商品失败 | 根据具体修改的信息修正 |
BIZ_ILLEGAL_LOCK_OPERATE_FAILED | 商品不能操作(如存在活动等) | 不允许对该商品进行操作 |
ITEM_NOT_EXIST | 商品不存在 | 请核对商品ID |
BIZ_ILLEGAL_ON_SALE_OPERATE_FAILED | 商品价格高于其他外卖平台被强制下架,请至商户端商品-违规中查看修改后重新上架 | 修改允许的价格再重新上架 |
BIZ_CATEGORY_NOT_EXIST | 商品分类不存在 | 检查参数 |
PERMISSION_DENIED | 该账号没有管理xx店铺的权限 | 店铺未授权或是用错了店铺所对应的token(用了A店铺授权的token去操作B店铺的数据了) |
BIZ_ITEM_NOT_EXIST | 商品不存在 | 请检查传入的商品ID是否正确或商品是否已被删除 |
CATEGORY_NOT_EXIST | 商品分类不存在 | 商品分类ID传入错误或是该商品分类已被删除 |
REMOVE_FOOD_FAILED | 商品参与有优惠活动,活动期间不能删除 | 活动商品不能直接删除,需先取消活动 |
INVALID_ORDER_ID | 不合法订单id | 订单ID传入错误,请输入正确的订单号 |
BIZ_SERVER_ERROR | 取消订单失败 | 请检查订单状态,取消发生在订单完结之前,退单发生在订单完结之后;已取消或处于取消中的订单无需再次操作取消 |
BIZ_STATE_SYNC_FAIL | 配送状态同步失败 不允许重复更新交付状态 | 请检查订单状态和配送状态:已完结和已取消的订单不允许再更新配送状态;已更新成功的配送状态不允许重复更新 |
ORDER_SHOP_NOT_MATCH_ATORZ | 下单店铺与授权店铺不匹配 | 请检查店铺与授权店铺的匹配关系 |
TEMPLATE_PARAM_NOT_MATCH_TEMPLATE | 模板参数与模板不能完全匹配 | 请检查模板参数与模板要想匹配 |
INVALID_SLUG | 无效的短信模板 | 请上传正确的模板编号 |