Documentatie/API-referentie

API REFERENCE

Apparaten opvragen

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

Apparaten opvragen

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.

Handelaren gebruiken deze API om de lijst met POS-apparaten op te halen.

API-URL (productie): https://mapi.yabandpay.com/Payments

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

Methode:POST

POST gegevenstype:Json

ParameterTypeBeschrijvingVerplicht
userStringUID van het superbeheerdersaccount op handelaarsniveauVerplicht
signStringSignatureVerplicht
methodStringv3.GetPOSListVerplicht
timeLongTimestampVerplicht
  • Parameters
ParameterTypeBeschrijvingVerplicht
request_idStringUnieke aanvraag-ID; aanbevolen wordt een combinatie van cijfers en letters van ten minste 24 tekensVerplicht

Handtekeningvoorbeeld:

Gesorteerde parameters aaneengevoegd tot een queryreeks in URL-stijl

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

Onderteken stringA met secret_key

De resulterende handtekening is:

"YOUR_SIGNATURE"

Aanvraagvoorbeeld:

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

Antwoordvoorbeeld:

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

Aanvullende informatie:

Resultaat van het antwoord:
  1. Een geslaagde aanvraag retourneert "status": true.

  2. Een mislukte aanvraag retourneert "status": false.

Antwoordcodes:
StatusCodeBericht
true200Success
false-1000Internal error
false-3001Required field is missing
false-3002duplicate request_id
false-403The signature Error