API REFERENCE
Consultar dispositivos
Parâmetros
| Parameter | Type | Descrição | Obrigatório |
|---|---|---|---|
| data.request_id | string | 请求id需保持唯一，建议24以上位数字+字母 | ✓ |
Os comerciantes utilizam esta API para obter a lista de dispositivos POS.
API URL (production): https://mapi.yabandpay.com/Payments
API URL (test): https://acc-mapi.yabandpay.com/Payments
| Parâmetro | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| user | String | UID da conta de superadministrador ao nível do comerciante | Obrigatório |
| sign | String | Signature | Obrigatório |
| method | String | v3.GetPOSList | Obrigatório |
| time | Long | Timestamp | Obrigatório |
- Parameters
| Parâmetro | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| request_id | String | ID de pedido único; recomenda-se uma combinação de letras e números com pelo menos 24 caracteres | Obrigatório |
Signature example:
Parâmetros ordenados e concatenados numa cadeia de consulta no formato de URL
"method=v3.GetPOSList&request_id=a7z1lox4l6z6mdx1udgn5gtezasze1x0&time=1560753647&user=YOUR_CASHIER_UID"
Assine a stringA utilizando secret_key
A assinatura resultante é:
"YOUR_SIGNATURE"
Request example:
{
"user": "YOUR_CASHIER_UID",
"sign": "YOUR_SIGNATURE",
"method": "v3.GetPOSList",
"time": 1560753647,
"data": {
"request_id": "a7z1lox4l6z6mdx1udgn5gtezasze1x0"
}
}
Response example:
{
"status": true,
"code": "200",
"data": {
"POS": [
{
"tid": "T125118250",
"uid": "T125118250",
"sn": "N62XXXXXXXX",
"model": "N62",
"secretkey": "YOUR_SECRET_KEY",
"store_id": "1265484354",
"store_name": "test store1"
},
{
"tid": "T125118251",
"uid": "T125118251",
"sn": "N62XXXXXXXX",
"model": "N62",
"secretkey": "YOUR_SECRET_KEY",
"store_id": "1265484354",
"store_name": "test store1"
},
{
"tid": "T125118252",
"uid": "T125118252",
"sn": "N62XXXXXXXX",
"model": "N62",
"secretkey": "YOUR_SECRET_KEY",
"store_id": "1265484355",
"store_name": "test store2"
}
]
},
"message": ""
}
Additional information:
Response result:
-
Um pedido bem-sucedido devolve "status": true.
-
Um pedido mal-sucedido devolve "status": false.
Response codes:
| Status | Code | Message |
|---|---|---|
| true | 200 | Success |
| false | -1000 | Internal error |
| false | -3001 | Required field is missing |
| false | -3002 | duplicate request_id |
| false | -403 | The signature Error |