Az API-kapcsolat (MPAPI) az üzlet és a MALL / MIMOVRSTE Partner-környezet összekapcsolására szolgál, azaz információk cseréjére a termékekről és azok változatairól, a szállítási beállításokról és nem utolsósorban a megrendelések feldolgozásáról.

Az API az úgynevezett REST architektúrán alapul, amely lehetővé teszi az adatokhoz való hozzáférést és olyan műveletek végrehajtását, mint például az adatok felsorolása, létrehozott objektumok (termékek, szállítás stb.) Létrehozása, frissítése vagy törlése.
Az API biztonságos HTTPS kapcsolatot használ.

A funkcionális kapcsolathoz egyedi kulcsot kell beszerezni a MALL Partnertől - client_id , amelyet az elküldött kérések engedélyezésére használnak.

Ezeket a kéréseket elküldjük a címre 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 Ügyfélazonosító.

Az összes adatot JSON formátumban és UTF-8 kódolással küldik és küldik vissza. Az elküldött kérésre adott válasz mindig HTTP-kódot ad vissza, a megfelelő módszerekben adatokat és esetleg lapozást is.

{"result": {"code": 200/400/403/404/500, "status": OK / ERROR / LIMITED, "message": kiegészítő üzenet}, "paging": {"pages": oldalak száma, "méret": elemek száma oldalanként, "oldal": aktuális oldal}, "adatok": {strukturált adatok}}

Az online dokumentációban részletes információk találhatók a HTTP-kódokról, a személyhívó használatról és különösen az előírt adatstruktúráról.

MPAPI kliens áll rendelkezésre a gyorsabb megvalósításhoz (jelenleg csak PHP-ben, az 5.5-ös és újabb verziók támogatottak). A letöltési információk és a legújabb verzió megtalálható a packagist.org/packages/mallgroup/mpapi-client oldalon .

Változási napló

Az online dokumentáció aktuális információkat tartalmaz. Az esetleges változásokat a Changelog szakasz rögzíti, ideértve a lejárati dátumot is.

API architektúra

Az MP API a REST szoftverarchitektúrán alapul, és HTTPS protokollal van biztonságban.

API végpontok

Alt szöveg

1. Átlátszó proxy

  • Átlátszó proxy használható független API tesztelésre (az online dokumentációból hívhatja a Mock Server vagy a Debugging Proxy módokat),
  • Az átlátszó proxy kérelmeket a felső menü Ellenőr linkjére kattintva követheti nyomon.
  • ha nem használ átlátszó proxyt, kéréseket küldhet közvetlenül a termelési környezet URI-végpontjainak.

2. Termelési környezet

  • A gyártási API URL-jét a https://mpapi.mallgroup.com/v1/ címen találja meg, az URL minden nyelvi verzióra érvényes, de az egyes országokra más és más ügyfél_azonosító érvényes.

Engedélyezés

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

Adatformátum

Minden adat JSON formátumban van és UTF-8 kódolású. A tartalom típusa beállítható Content-Type: application / json vagy Content-Type: application / json; Jelkészlet = UTF-8 .

Tárgyazonosítás

A felület minden objektumának (pl. Termékek / változatok) egyedi azonosítóval kell rendelkeznie, amelyet a partner kezel:

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

Kivételt képeznek például a megrendelések, a szállítás vagy a számlák. A MALL / MIMOVRSTE megrendelések esetén létrehoz egy order_id azonosítót , amely ezután elérhető például a nyitott megrendelések listájában . Ez az azonosító numerikus, és a megrendelés feldolgozásakor kell használni.

Figyelmeztetés :
A MALL order_id meghaladja a PHP 32 bites verziójának maximálisan megengedett egész méretét. A következetlen rendelési adatok elkerülése érdekében kérjük, használja a 64 bites verziót.

Kijárat

A kimenet a következő felépítésű:

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

A DELETE kérések nem adnak vissza semmilyen tartalmat (kód: 204).

Eredmény

Az eredmény visszaadja a HTTP- kódot, az állapotot és az esetleges hibaüzeneteket.

Lapszámozás

Object lapozás használható, ha a kimenetet van osztva több oldalt.
A lapozást úgy állíthatjuk be, hogy meghívunk egy URL-t a page and page_size paraméterekkel. Az alapértelmezett oldalméret (valamint az ajánlott maximum) 100 .

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

Adat

Az adatstruktúra a végponttól függően változik, és az online dokumentációban mindegyik végpontra külön leírják.

HTTP állapotkódok

  • 200 OK - minden rendben van, az adatokat helyesen adják vissza,
  • 201 létrehozva - a beküldött adatok beérkeztek és az entitás létrejött,
  • 204 Nincs tartalom - a kérésére adott válasz nem tartalmaz adatokat,
  • 400 Bad Request - az ügyfél által küldött adatok érvénytelenek (a hiba részletes leírása az üzenet attribútumában jelenik meg ),
  • 401 jogosulatlan - illetéktelen hozzáférés, hiányzó vagy rossz ügyfél_azonosító ,
  • 404 nem található - a szükséges adatok nem találhatók,
  • 500 belső kiszolgáló hiba - belső kiszolgáló hibát okoz például az, hogy nem érhető el az egyik rendszerinterfész (adatbázisok, webszolgáltatások, SAP stb.).

API funkciók

Az API funkciókat a megfelelő HTTP módszerek hívják meg:

  • A GET visszaadja az objektum adatait, nem végez semmilyen módosítást,
  • A POST új adatobjektumot küld,
  • A PUT frissíti a meglévő adatobjektumot,
  • A DELETE törli egy adatobjektumot.

Az adatok ellenőrzése

Az API kéréseket ellenőrzik. Ha vannak olyan hibák, amelyeket ki kell javítani, a hibák törzskönyvét visszaküldi a válasz törzsében.

Opcionális paraméterek

Ha a tulajdonság nem kötelező, és nem akarja használni, ne vegye fel az API kérésbe. Ha üres értékkel állítja be, akkor a (z) {kulcs} hibaüzenet nem létezik, vagy üres .

Képek

A termék / változat kép frissítéséhez meg kell változtatnia a kép URL-jét.
Például paraméter hozzáadásával az űrlapba IDŐBÉLYEG vagy Termék / változat azonosítója a kép URL-jére.
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 termékek maximális száma 20. A kép URL maximális válaszideje 1 s. A kép URL-je nem tartalmazhat szóközt vagy ékezetet.

Védelem a termék árának akaratlan változása ellen

Bizonyos kockázatok vannak abban a helyzetben, amikor a partner különböző e-boltokban frissíti a termékeket különböző pénznemekkel.
A partner nem megfelelő pénznemben küldheti el a termék árát. Ennek a kockázatnak a részleges kiküszöbölése érdekében határértéket határoznak meg a termékárak védelmére.
A megengedett árkülönbség a termék / változat régi és új ára között 30 % .

Ha a termék / változat árváltozása meghaladja a beállított határt, akkor a force_token jelenik meg a válaszban, és a termék / változat nem frissül.

Jelentős árkülönbséggel rendelkező termék ezért csak használatkor frissíthető erőltetett a sikertelen termékfrissítésből származik. A következő kérelemben el kell küldeni a kapottat erőltetett URL-paraméterként.

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

A termék árának frissítésével a erőltetett, a partner megerősíti, hogy az új ár helyes és teljes felelősséget vállal az újonnan megállapított árért.
Ezekben az esetekben az elővigyázatosság helyben érvényes, és nem alkalmazható erőltetett automatikusan. Minden változtatást és tokenhasználatot a MALL rögzít.
Használja a CZ-n kívüli országokban összegelválasztóként pont ""..

Egy példa:

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

API végpontok

  • Márkák - Az elérhető márkák listája.
  • Kategória - Az elérhető kategóriák listája, az ezekhez a kategóriákhoz elérhető termékparaméterek, ezen paraméterek esetleg elérhető értékei és a MENU MALL fa.
    A szükséges adatokat megtalálhatja a MALL Partner portál szakaszában is Kategória.
    A kategóriák, a válogatási paraméterek és értékeik részletesebb leírása a cikkben található itt.
  • Transzportok - A MALL oldalon és azok részletein alapuló fuvarozók listája. Ebből a listából a partner "kiválasztja" azt a szolgáltatót, amelyet használni fog.
  • Szállítások - A partner által létrehozott és a MALL-nak visszaküldött szállítások. A partner által küldött szállítás ekkor elérhető lesz a kosárban.
  • Címkék - Az összes elérhető címke felsorolása. A partner a címkéket az értékesítési támogatás részeként használja a MALL / MIMOVSRTE utasítása alapján.
  • Rendelések - Minden rendelkezésre álló rendelési adat. Tartalmazza az összes megrendelés listáját, az összes megrendelésre vonatkozó alapadatok listáját, a megrendelések listáját a különféle állapotok szerint, a megrendelés részleteit, a rendelések frissítését, a MALL szállítás címkéinek előállítását és még sok mást. A biztonság részeként (a felkészületlen megrendelések partner általi elküldésének megakadályozása) a "blokkolt" állapotú megrendeléseket szándékosan eltávolítják bizonyos nyilatkozatokból, ezért külön kell őket meghívni. A megrendelések változásai nyomon követhetők a webhook eszközzel.
  • Partnerek - Általános információk és partnerbeállítások. Tartalmazza az ellátási késleltetés beállításait a teljes partner szintjén.
  • Termékek - Partnertermékek létrehozása, szerkesztése és törlése. Tartalmazza az összes termék listáját, az összes termékre vonatkozó alapadatok listáját, új termékek létrehozását, a "vázlat" termékek aktiválását, a termékek elérhetőségének és árainak frissítését és egyebeket.
  • Változatok - A termékekhez hasonlóan lehetőség van partneri termékek változatainak létrehozására, szerkesztésére és törlésére is.
  • Ellenőrzés - Ellenőrizze az adatok konzisztenciáját. A lehetőségek között szerepel a szállítások és az adathordozók ellenőrzése.
  • Számlák - A számlák listája és részletei arra az esetre, ha a partner önszámlázást alkalmazna . Lehetőség a számla fájlként való letöltésére.
  • Hitelek - A kreditek listája és részletei arra az esetre, ha a partner önszámlát használ. Lehetőség a jóváírás fájlként való letöltésére.

Mennyire volt hasznos ez a bejegyzés?

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

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

Még nincs szavazat! Értékelje elsőként ezt a bejegyzést.