Webhely ikon MALL Partner - Piaci segítség

API-kapcsolati utasítások

pavelzunic

Az API-kapcsolat (MPAPI) az Ön áruházának és a MALL/MIMOVRSTE Partner környezetének összekapcsolására szolgál, azaz a termékekre és azok változataira, a szállítási beállításokra és nem utolsósorban a megrendelések feldolgozására vonatkozó információk cseréjére.

Az API az úgynevezett REST architektúrán alapul, amely lehetővé teszi az adatokhoz való hozzáférést és az azokon végzett műveleteket, mint például az adatdömping, az objektumok (termékek, szállítások stb.) létrehozása, frissítése vagy törlése.
Az API biztonságos HTTPS-kapcsolatot használ.

A működőképes kapcsolathoz egyedi kulcsot kell beszerezni a MALL Partnertől. client_id, amely a küldött kérelmek engedélyezésére szolgál.

Ezeket a kéréseket a következő címre küldik https://mpapi.mallgroup.com/ termelési környezetben, függetlenül attól, hogy melyik országban kínálja termékeit.
Az országot a következőkkel azonosítják client_id.

Minden adatot elküldünk és JSON formátumban és UTF-8 kódolásban érkeznek vissza. Az elküldött kérésre adott válasz a következőket adja vissza mindig HTTP-kódot, a megfelelő metódusokban adatokat és esetleg lapozást is. 

{
   "result": {
         "code": 200/400/403/404/500,
         "status": OK/ERROR/LIMITED,
         "message": további üzenet
   },
   "paging": {
         "pages": az oldalak száma,
         "size": az oldalon lévő elemek száma,
         "page": aktuális oldal
   },
   "data": {
          strukturált adatok
   }
}

A HTTP-kódokról, a lapozás használatáról és különösen az előírt adatszerkezetről részletes információ a következő dokumentumban található online dokumentáció.

A gyorsabb megvalósítás érdekében a következők állnak rendelkezésre MPAPI ügyfél (jelenleg csak PHP-ben, az 5.5-ös és újabb verzió támogatott). Letöltési információk és a legújabb verzió a következő címen található meg packagist.org/packages/mallgroup/mpapi-client.

Changelog

Online dokumentáció naprakész információkat tartalmaz. Minden változás a Changelog szakaszban kerül rögzítésre, beleértve az érvényesség dátumát is.

API architektúra

Az MP API szoftverarchitektúrán alapul REST és biztosítva HTTPS protokoll.

API végpontok

1. Átlátható proxy

2. Termelési környezet

Engedélyezés

Minden kérelemnek tartalmaznia kell engedélyezési kulcs (ügyfél azonosító). Ez a kulcs a partnerek számára elérhető a partnerportálon.

Adatformátum

Minden adat a következő formátumban van JSON és kódolva UTF-8. A tartalom típusa beállítható Content-Type: application/json vagy Content-Type: application/json; Charset=UTF-8.

Tárgyak azonosítása

Az interfész minden objektumának (pl. termék/változat) egyedi azonosítóval kell rendelkeznie, amelyet a partner kezel:

  • A MALL nem rendel semmilyen számsort a partnerekhez,
  • Az azonosítók legfeljebb 50 karakterből álló kombinációkat tartalmazhatnak, a megengedett karakterek a következők: _ - 0-9 a-z A-Z A-Z (aláhúzások, kötőjelek, számok nullától kilencig, kis- és nagybetűk ékezetek nélkül).
  • Az azonosítónak a partner szintjén egyedinek kell lennie.

Kivételt képeznek például a megrendelések, a szállítás vagy a számlák. A megrendelések esetében a MALL/MIMOVRSTE a következőket generálja order_id, amely aztán elérhető például a nyitott megbízások listája. Ez az azonosító numerikus, és a megrendelés feldolgozásakor kell használni.

Értesítés:
MALL order_id meghaladja a PHP 32 bites verziójának maximálisan megengedett egész szám méretét. A rendeléseknél az ellentmondásos adatok elkerülése érdekében kérjük, használja a 64 bites verziót.

Retrieved from

A kimenet a következő szerkezetű:

{
    "result": {
        "code": 200/400/403/404/500,
        "status": OK/ERROR/LIMITED,
        "message": további hibainformáció
    },
    "paging": {
        "pages": az oldalak száma,
        "size": az objektumok száma egy oldalon,
        "page": az aktuális oldal száma
    },
    "data": {
        adatszerkezet
    }
}

A DELETE kérések nem küldenek vissza semmilyen tartalmat (204-es kód).

Eredmény

Az eredmény a következő HTTP kód, állapot és hibaüzenet.

Oldalszámozás

Objektum lapozás akkor használatos, ha a kimenet több oldalra van osztva.
A lapozás az URL paraméterekkel történő meghívásával állítható be. oldal a page_size. Az alapértelmezett oldalméret (és egyben az ajánlott maximális érték) a következő 100.

Példa:
https://mpapi.mallgroup.com/v1/products?client_id={clientId}&page={page}&page_size={pageSize}

Adatok

Az adatszerkezet a végponttól függően változik, és minden egyes végpontra külön-külön a következő dokumentumban van leírva online dokumentáció.

HTTP állapotkódok

API funkciók

Funkciók API a megfelelő módszerek hívják meg HTTP:

Adatérvényesítés

Az API-kérelmeket ellenőrzik. Ha vannak javítandó hibák, a válasz testében visszaküldjük a hibák listáját.

Választható paraméterek

Ha egy tulajdonság opcionális, és nem szeretné használni, ne adja meg az API-kérelemben. Ha üres értékkel állítja be, hibaüzenet érkezik vissza. A kulcs {key} nem létezik vagy üres.

Képek

A termék/variáns kép frissítéséhez a kép URL-címét kell megváltoztatni.
Például egy paraméter hozzáadásával a következő formában TIMESTAMP vagy Termék azonosító/változatok a kép URL címéhez.
A képek maximális felbontása 2000 px x 2000 px, a minimális képméret 100 KB, a maximális méret pedig 2 MB. A képek maximális száma termékenként 20. A kép URL címe nem tartalmazhat szóközöket és diakritikus jeleket.

Energiacímke

Útmutató az új energiacímkékről

Védelem a termékár nem szándékos változásai ellen

Bizonyos kockázatokkal jár, ha egy partner különböző pénznemű webáruházakban frissíti a termékeket.
Előfordulhat, hogy a partner rossz pénznemben küldi a termék árát. E kockázat részleges kiküszöbölése érdekében a termék árának védelmére küszöbértéket állítunk be.
A termék/variáns régi és új ára közötti megengedett árkülönbség a következő 30 %.

Ha a termék/variáns árváltozása magasabb, mint a határérték, a válaszban visszaküldjük. force_token és a termék/variáns nem frissül.

A jelentős árkülönbséggel rendelkező termék tehát csak a következő eszközökkel frissíthető force_token egy sikertelen termékfrissítésből. A következő kérésben el kell küldenie a lekérdezett force_token URL paraméterként.

Példa:
https://mpapi.mallgroup.com/v1/products/{productId}?client_id={clientId}&force_token={forceToken}

A termék árának frissítésével a force_token, a partner megerősíti, hogy az új ár helyes, és hogy teljes felelősséget vállal az új árért.
Ezekben az esetekben helyben óvatosnak kell lenni, ezért nem tanácsos használni a force_token automatikusan. A MALL minden módosítást és tokenhasználatot rögzít.
A Cseh Köztársaságon kívüli országokban mennyiségleválasztóként kell használni. pont ".".

Példa:

{
  "errorCodes": [
    {
      "message": "A "{termék azonosító}" termék jelenlegi ára ({a jelenlegi ár értéke}) és új ára ({az új ár értéke}) közötti különbség nagyobb, mint 30% ({valós százalékos különbség}). A változás megerősítéséhez használja a csatolt force tokent.",
      "errorCode": "INCORRECT_PRODUCT_PRICE_DIFFERENCE",
      "errorAttributes": {
        "current": "currentPrice",
        "new": "newPrice",
        "id": "productId"
      }
    }
  ],
  "result": {
    "code": 400,
    "status": "ERROR",
    "message": "A "{termék azonosító}" termék jelenlegi ára ({a jelenlegi ár értéke}) és új ára ({az új ár értéke}) közötti különbség nagyobb, mint 30% ({valós százalékos különbség}). A változás megerősítéséhez használja a csatolt force tokent."
  },
  "data": {
    "key": "product.variants",
    "data": {
      "forceToken": "b3f7d1feca4c649e3493b466cbe0e6795bc6f679",
      "variantIndex": 0
    }
  }
}

API végpontok

Mennyire volt hasznos ez a bejegyzés?

Kattintson a csillagra a bejegyzés értékeléséhez!

Átlagos értékelés: 3 / 5. Szavazatok száma: 4

Még senki sem szavazott. Legyen Ön az első, aki értékeli ezt a hozzászólást.

Kilépés a mobil verzióból