Pobierz Instrukcję

Transkrypt

Pobierz Instrukcję
INSTRUKCJAPODŁĄCZANIA
SKLEPU
DOPLATFORMYmSHOPPING
RESTAPI
Użytkownikmożepodłączyćkażdysklepużywającwbudowanegointerfejsu
mShopping.Wtymcelumusiprzygotowaćpodstawowyadres,podktórym
będądostępnewszystkieakcjedlaRESTAPI,np:http://sklep.domain/restapi.AkcjetewysyłanesąodpowiednimimetodamiHTTP(np.POST,GET,PUT,
DELETE)izwracająresponsezestatusem200(jeślipowiodłosię)lub500jeśliwystąpiłbłąd.WprzypadkubłęduResponsemanastępującąstrukturę:
JSONResponse (Status500):
[
'message'=>'Komunikat błedu',
]
KROK1:TOKENUWIERZYTELNIAJĄCY
GET/get-token
JSONResponse (Status200):
[
'token'=>'token uwierzytelniający',
]
KROK2:LOGOWANIENAKONTO
UŻYTKOWNIKA
POST/process-login
Body:
[
'login'=>'Login',
'pass'=>'Hasło',
]
JSONResponse(Status200):
[
'user_id' =>'idużytkownika',
'user_name' =>'nazwa użytkownika',
]
KROK3:WYLOGOWYWANIE
POST/process-login
Body:
[
'user_id'=>'Idużytkownika',
]
JSONResponse(Status200):
[
'result'=>true,
]
KROK4(1):POBIERANIEDRZEWKAKATEGORII
GET/get-categories
JSONResponse (Status200):
[
[
'id'=>'Idkategorii',
'name'=>'Nazwakategorii',
'children'=>null,
],
[
'id'=>'Idkategorii',
KROK4(2):POBIERANIEDRZEWKAKATEGORII
'id'=>'Idkategorii',
'name'=>'Nazwakategorii',
'children'=>[
[
'id'=>'Idpodkategorii',
'name'=>'Nazwapodkategorii',
'children'=>//nulllubkolejnepodkategorie
]
],
],
(...)
]
KROK5:LISTAPRODUKTÓWWKATEGORII
GET/get-products/:cat_id://cat_id - idkategorii
JSONResponse (Status200):
[
[
'id'=>'Idproduktu',
'name'=>'Nazwaproduktu',
'desc'=>'Opis',
'price'=>100.21,//cenaproduktu (float)
'img' =>'adres_url_obrazka',
],
(...)
]
KROK6:DODAWANIEPRODUKTUDO
KOSZYKA
GET/get-products/:cat_id://cat_id - idkategorii
JSONResponse (Status200):
[
[
'id'=>'Idproduktu',
'name'=>'Nazwaproduktu',
'desc'=>'Opis',
'price'=>100.21,//cenaproduktu (float)
'img' =>'adres_url_obrazka',
],
(...)
]
KROK7:DODAWANIEPRODUKTUDO
KOSZYKA
PUT/cart/update-products
Body:
[
[
'prod_id'=>'idproduktu',
'qty'=> 'Cenaproduktu',
],
(...)
]
JSONResponse (Status200):
[
[
'result'=> true
],
]
KROK8:POBIERANIEZAWARTOŚCIKOSZYKA
GET /cart/get
JSONResponse (Status200):
[
'products'=>[
[
'id' =>'idproduktu',
'qty'=>'ilość',
],
(...)
]
'base_price' => 350,//kwotapełna,bezzniżki
'discount'=>100,//zniżka
'total_price' =>250,//kwotaostateczna(base_price - discount)
]
KROK9:ZŁOŻENIEZAMÓWIENIA
POST/cart/order
Body:
[
'first_name'=>'Imię',
'last_name' =>'Nazwisko',
'city'=>'Miasto',
'address'=>'Ulicainumerdomu/mieszkania',
'postcode'=>'kodpocztowy',
'telephone'=>'telefonkontaktowy',
]
JSONResponse(Status200):
[
[
'result'=>true
],
]