友朋运营商开放平台
  1. API 列表
友朋运营商开放平台
  • 友朋运营商平台第三方开放平台接口文档
  • 业务场景
    • 场景:自取柜第三方支付业务逻辑
    • 场景:异步通知第三方业务回调地址
    • 场景:自取柜售货机订单同步给第三方
  • API 列表
    • api.test
      POST
    • cabinet.list
      POST
    • cabinet.product.stock
      POST
    • cabinet.open.door
      POST
    • cabinet.order.refund.apply
      POST
    • cabinet.order.user.appeal
      POST
    • cabinet.order.list
      POST
    • cabinet.order.get
      POST
    • consumer.order.list
      POST
    • consumer.order.get
      POST
  1. API 列表

cabinet.open.door

POST
https://api.yopoint.com/api/gateway/index
使用场景:
用于第三方支付开发,创建订单并通知设备开门。
开门失败的 sub_error_code
中文错误提示错误码(sub_error_code)英文错误提示(sub_error_msg)
设备还未激活,请先配置后重试400001ERR_CABINET_ACTIVESTATUS_INVALID
设备维护中: 设备未开启售卖状态400002ERR_CABINET_NOT_ON_SALE
提示: 你有不良记录,暂无法提供服务,如需解除请联系运营商400003ERR_USER_HAS_RECORD_UNABLE_TO_PROVIDE_SERVICES
提示: 您有等待支付的订单,请支付后再开门400004ERR_USER_HAS_UNPAID_ORDER_UNABLE_TO_OPEN_DOOR
运营商系统维护中,维护代码: 888888400005ERR_VISUAL_IDENTITY_FEE_ARREARS
设备服务已到期,请续费后重试400006ERR_VISUAL_IDENTITY_FEE_EXPIRED
设备维护中: 设备断网了,请稍后再试400007ERR_CABINET_MAINTENANCE_NETWORK_ISSUE
错误: 设备状态获取失败,请反馈给友朋400008ERR_CABINET_STATUS_FETCH_FAILED
设备维护中:请先设置商品售价400009ERR_CABINET_MAINTENANCE_SET_PRICE_FIRST
错误:订单创建失败,请反馈给友朋400010ERR_ORDER_CREATION_FAILED
错误: 自取柜开门失败400011ERR_LOCKER_OPEN_DOOR_FAILED
错误: 设备不在线,开门失败400012ERR_DEVICE_OFFLINE_OPEN_DOOR_FAILED
错误: 自取柜被禁用, 请联系友朋客服400013ERR_LOCKER_DISABLED_CONTACT_SUPPORT
提示: 设备正在购物/补货中, 开门失败400014ERR_DEVICE_IN_USE_OPEN_DOOR_FAILED
错误: 设备断电, 请检查设备电源线400015ERR_DEVICE_POWER_OFF_CHECK_POWER_CABLE
错误: 设备摄像头异常,开门失败400016ERR_DEVICE_CAMERA_FAULT_OPEN_DOOR_FAILED
错误: 设备异常或欠费, 请联系友朋400017ERR_DEVICE_FAULT_OR_FEE_DUE_CONTACT_SUPPORT
错误: 开门失败,设备未配置商品,请联系商家400018ERR_OPEN_DOOR_FAILED_DEVICE_NOT_CONFIGURED_CONTACT_MERCHANT
错误: 设备门锁异常,开门失败400019ERR_DEVICE_DOOR_LOCK_FAULT_OPEN_DOOR_FAILED
错误: 用户开门过于频繁, 请稍后重试400020ERR_USER_OPEN_DOOR_TOO_FREQUENTLY_TRY_AGAIN_LATER
错误: 未知错误,请联系友朋客服400021ERR_UNKNOWN_ERROR_CONTACT_SUPPORT
错误: 设备不在线, 请联系友朋客服400022ERR_DEVICE_OFFLINE_CONTACT_SUPPORT

请求参数

Header 参数
Content-Type
string 
必需
默认值:
application/x-www-form-urlencoded
Body 参数multipart/form-data
appid
string 
必需
示例值:
{{appid}}
method
string 
必需
示例值:
cabinet.open.door
biz_content
string 
必需
cid即设备ID;
tradeNo第三方系统唯一的订单号,尽可能采用支付通道的订单号,避免后期二次对账;
mobile 消费者手机号或唯一ID,运营商后台处理售后问题时需使用,请确保数据真实可用;
doorNum 设备门号 单门柜传 1;双门柜右门为 1,左门为 2。
示例值:
{"cid":"5f6da2362201410011fe7b72","tradeNo":"12345678909","mobile":"13800138000","doorNum":1}
version
string 
必需
示例值:
1.0.0
timestamp
string 
必需
示例值:
{% mock 'timestamp', 's' %}
sign_type
string 
必需
示例值:
md5

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.yopoint.com/api/gateway/index' \
--form 'appid=""' \
--form 'method="cabinet.open.door"' \
--form 'biz_content="{\"cid\":\"5f6da2362201410011fe7b72\",\"tradeNo\":\"12345678909\",\"mobile\":\"13800138000\",\"doorNum\":1}"' \
--form 'version="1.0.0"' \
--form 'timestamp="{% mock '\''timestamp'\'', '\''s'\'' %}"' \
--form 'sign_type="md5"'

返回响应

🟢200成功
application/json
Body
error_code
integer 
必需
0代表成功,-1代表签名错误
error_msg
string 
必需
sub_error_code
null 
必需
sub_error_msg
null 
必需
data
object 
必需
ReceiptNo
string 
友朋订单号
必需
唯一
NotifyUrl
string 
此订单的回调地址
必需
开发者将此订单支付结果通知到此URL
示例
{"error_code":0,"error_msg":"SUCCESS","sub_error_code":null,"sub_error_msg":null,"data":{"ReceiptNo":"VI240110172526108140","NotifyUrl":"https://c.yopoint.com/thirdpay/gateway/cabinet_notify/5e6b52d1b427cd001094a32a"}}
修改于 2024-03-09 14:20:09
上一页
cabinet.product.stock
下一页
cabinet.order.refund.apply
Built with