Documentation/Référence API

API REFERENCE

Consulter les appareils

POSThttps://mapi.yabandpay.com/Payments
Live API
API PLAYGROUND · Live API

Consulter les appareils

POSThttps://mapi.yabandpay.com/Payments
Automatically signed with your credentials

Request parameters1

Required fields first

设备查询

request_idRequiredstringdata.request_id请求id需保持唯一,建议24以上位数字+字母

Credentials stay on this page. Your secret key is never stored or sent to the documentation server.

Paramètres

ParameterTypeDescriptionObligatoire
data.request_idstring请求id需保持唯一,建议24以上位数字+字母✓

Les marchands utilisent cette API pour récupérer la liste de leurs appareils POS.

URL de l’API (production) : https://mapi.yabandpay.com/Payments

URL de l’API (test) : https://acc-mapi.yabandpay.com/Payments

ParamètreTypeDescriptionObligatoire
userStringUID du compte super administrateur au niveau du marchandObligatoire
signStringSignatureObligatoire
methodStringv3.GetPOSListObligatoire
timeLongTimestampObligatoire
  • Parameters | Paramètre | Type | Description | Obligatoire | |:--- |:--- |:--- |:--- | | request_id | String | ID de requête unique ; une combinaison de chiffres et de lettres d’au moins 24 caractères est recommandée | Obligatoire |

Exemple de signature :

Paramètres triés et concaténés dans une chaîne de requête au format URL

"method=v3.GetPOSList&request_id=a7z1lox4l6z6mdx1udgn5gtezasze1x0&time=1560753647&user=YOUR_CASHIER_UID"

Signer stringA avec secret_key

La signature obtenue est :

"YOUR_SIGNATURE"

Exemple de requête :

{
	"user": "YOUR_CASHIER_UID",
	"sign": "YOUR_SIGNATURE",
	"method": "v3.GetPOSList",
	"time": 1560753647,
	"data": {
		"request_id": "a7z1lox4l6z6mdx1udgn5gtezasze1x0"
        }
}

Exemple de réponse :

{
    "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": ""
}

Informations complémentaires :

Résultat de la réponse :
  1. Une requête réussie renvoie "status": true.

  2. Une requête échouée renvoie "status": false.

Codes de réponse :
StatusCodeMessage
true200Success
false-1000Internal error
false-3001Required field is missing
false-3002duplicate request_id
false-403The signature Error