友朋运营商开放平台
  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 列表

api.test

POST
https://api.yopoint.com/api/gateway/index

接口 api.test#

接口说明#

测试接口,用于测试签名,参数是否正确
当 error_msg = -1 时,代表签名有问题
错误提示说明
ERR_PARAMS_TIMESTAMP时间戳不对
ERR_SIGN_INVALIDATE签名不对
ERR_PARAMS_SIGN_TYPE签名类型不对

请求参数

Header 参数
Content-Type
string 
必需
默认值:
application/x-www-form-urlencoded
Body 参数multipart/form-data
appid
string 
必需
示例值:
{{appid}}
method
string 
必需
示例值:
api.test
biz_content
string 
必需
示例值:
{}
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="api.test"' \
--form 'biz_content="{}"' \
--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 
必需
thirdparty_row
object 
必需
reqParams
object 
必需
示例
{
    "error_code": 0,
    "error_msg": "SUCCESS",
    "sub_error_code": null,
    "sub_error_msg": null,
    "data": {
        "thirdparty_row": {
            "OID": "5e6b52d1b427cd001094a32a",
            "Name": "开发测试",
            "PermissionList": [
                "api.test"
            ],
            "CocaColaPermissionList": [],
            "NotifyUrl": "",
            "AppID": "204967487844",
            "AppSecret": "0012d0dtba99d5ca1adb1e081j56a0df",
            "Status": 1,
            "CreateAt": 1704867423,
            "UpdatedAt": 1704867423,
            "id": "659e365fbd3546001141d38a"
        },
        "reqParams": {}
    }
}
修改于 2024-01-11 05:53:24
上一页
场景:自取柜售货机订单同步给第三方
下一页
cabinet.list
Built with