AJAX i action filer
I denne artikel:
Hostedshops actions filer benyttes til at lægge varer i kurven, logge brugere ind mv. Det er nu blevet muligt at benytte AJAX til f.eks. at tilføje varer i kurven med og få et AJAX respons tilbage. På den måde undgår man et reload af siden, og opnår derved en bedre brugeroplevelse.
Muligheden vil blive udvidet efter behov.
Vores AJAX action filer eller AJAX endpoints er ikke REST API'er, men POST/GET endpoints med et JSON svar. Alle vores endpoints har underliggende actions der bestemmer hvilken endelige action der skal foretages på det enkelte endpoint. Med cart kunne det f.eks. være interesant at ligge noget i kurven, eller at fjerne noget fra kurven.
Alle endpoints leverer altid et ens svar. Et JSON object indeholder følgende parametre:
|
Parameter |
Værdi |
Beskrivelse |
|---|---|---|
|
text |
(string) |
Teksten som skal vises til brugeren |
|
status |
(int) |
Statuskode; 0 for success, 1 for fejl |
|
type |
(string) |
Action typen i et ord |
|
itemId |
(int) |
Id for opdaterede entitet, f.eks. et produkt |
Gennemgang af action endpoints:
Beskrivelse af /actions/cart/ endpoint:
Dette endpoint er til alle indkøbskurv handlinger. /actions/cart/ har følgende actions:
- /actions/cart/add (tilføj til kurv) - POST endpoint
|
Parameter |
Påkrævet |
Værdi |
Beskrivelse |
|---|---|---|---|
|
product[xx][amount] |
× |
(int) |
Produkt antal, der skal ligges i kurven, hvor xx er produkt id'et. |
|
product[xx][variant] |
|
(int) |
Produkt variant, hvor xx er produkt id'et |
|
product[xx][additional][yy][] |
|
(int) |
Produkt tilvalg, hvor xx er produkt id'et og yy er tilvalgs id'et. |
|
product[xx][packet_products][] |
|
(int) |
Produkt pakkeprodukt, hvor xx er produkt id'et er xx. |
- /actions/cart/remove (fjern fra kurv) - GET endpoint
|
Parameter |
Påkrævet |
Værdi |
Beskrivelse |
|---|---|---|---|
|
id |
× |
(int) |
Cart id'et, der skal slettes |
- /actions/cart/plus (opdater produkt i kurv med en ekstra) - GET endpoint
|
Parameter |
Påkrævet |
Værdi |
Beskrivelse |
|---|---|---|---|
|
id |
× |
(int) |
Cart id'et, der skal opdateres |
- /actions/cart/minus (fjern 1, ved 1 samme som remove, antal af enkelt produkt i kurv) - GET endpoint
|
Parameter |
Påkrævet |
Værdi |
Beskrivelse |
|---|---|---|---|
|
id |
× |
(int) |
Cart id'et, der skal opdateres |
- /actions/cart/update (genindlæs kurv) - GET endpoint
|
Parameter |
Påkrævet |
Værdi |
Beskrivelse |
|---|---|---|---|
|
|
|
|
|
- /actions/cart/empty (tøm kurv) - GET endpoint
|
Parameter |
Påkrævet |
Værdi |
Beskrivelse |
|---|---|---|---|
|
|
|
|
|
- /actions/cart/couponAdd (tilføj rabatkode til kurv) - POST endpoint
|
Parameter |
Påkrævet |
Værdi |
Beskrivelse |
|---|---|---|---|
|
coupon |
× |
(string) |
Kuponkode, der skal tilføjes kurven. |
- /actions/cart/couponRemove (fjern rabatkode fra kurv) - GET endpoint
|
Parameter |
Påkrævet |
Værdi |
Beskrivelse |
|---|---|---|---|
|
|
|
|
|
- /actions/cart/reorder (genbestil ordre) - GET endpoint
|
Parameter |
Påkrævet |
Værdi |
Beskrivelse |
|---|---|---|---|
|
id |
× |
(int) |
Ordre id'et, der skal genbestilles |
- /actions/cart/reorderItem (genbestil produkt fra ordre) - GET endpoint
|
Parameter |
Påkrævet |
Værdi |
Beskrivelse |
|---|---|---|---|
|
id |
× |
(int) |
Ordreline id'et, der skal genbestilles |
Beskrivelse af /actions/user/ endpoint:
Dette endpoint er til alle bruger handlinger. /actions/user/ har følgende actions:
- /actions/user/add (opret en bruger) - POST endpoint
|
Parameter |
Påkrævet |
Værdi |
Beskrivelse |
|---|---|---|---|
|
firstname |
× |
(string) |
Bruger fornavn |
|
lastname |
× |
(string) |
Bruger efternavn |
|
address |
× |
(string) |
Bruger adresse |
|
zipcode |
× |
(string) |
Bruger postnummer |
|
city |
× |
(string) |
Bruger bynavn |
|
|
× |
(string) |
Bruger email |
|
password |
× |
(string) |
Bruger kodeord |
|
passwordConfirmation |
× |
(string) |
Bruger kodeord bekræftelse |
|
vatNumber |
(afhængig af indstilling) |
(string) |
Bruger/virksomheds CVR |
|
eanNumber |
(afhængig af indstilling) |
(string) |
Bruger/offentlig EAN |
|
phone |
(afhængig af indstilling) |
(string) |
Bruger telefonnummer |
|
mobilephone |
|
(string) |
Bruger mobilnummer |
|
company |
|
(string) |
Bruger/virksomhedsnavn |
|
country |
|
(string) |
Bruger land |
|
countryCode |
|
(string) |
Bruger landekode |
|
state |
|
(string) |
Bruger state |
|
birthday |
|
(string) (dd/mm/yyyy) |
Bruger fødselsdag |
|
newsletter |
|
(boolean) |
Skal bruger tilmeldes nyhedsbrev |
|
interestGroups |
|
(int) eller (array) |
Id på bruger interessegrupper |
|
userGroup |
|
(int) |
Id på brugergruppe |
- /actions/user/logout (log bruger ud) - GET endpoint
|
Parameter |
Påkrævet |
Værdi |
Beskrivelse |
|---|---|---|---|
|
|
|
|
|
- /actions/user/login (log bruger ind) - POST endpoint
|
Parameter |
Påkrævet |
Værdi |
Beskrivelse |
|---|---|---|---|
|
username |
× |
(string) |
Brugernavn (email) |
|
password |
× |
(string) |
Bruger kodeord |
- /actions/user/login (log bruger ind) - POST endpoint
|
Parameter |
Påkrævet |
Værdi |
Beskrivelse |
|---|---|---|---|
|
username |
× |
(string) |
Brugernavn (email) |
|
password |
× |
(string) |
Bruger kodeord |
- /actions/user/add2b (opret en B2B bruger) - POST endpoint
|
Parameter |
Påkrævet |
Værdi |
Beskrivelse |
|---|---|---|---|
|
firstname |
× |
(string) |
Bruger fornavn |
|
lastname |
× |
(string) |
Bruger efternavn |
|
address |
× |
(string) |
Bruger adresse |
|
zipcode |
× |
(string) |
Bruger postnummer |
|
city |
× |
(string) |
Bruger bynavn |
|
|
× |
(string) |
Bruger email |
|
password |
× |
(string) |
Bruger kodeord |
|
passwordConfirmation |
× |
(string) |
Bruger kodeord bekræftelse |
|
vatNumber |
(enten VAT eller EAN) |
(string) |
Bruger/virksomheds CVR |
|
eanNumber |
(enten VAT eller EAN) |
(string) |
Bruger/offentlig EAN |
|
phone |
(afhængig af indstilling) |
(string) |
Bruger telefonnummer |
|
mobilephone |
|
(string) |
Bruger mobilnummer |
|
company |
|
(string) |
Bruger/virksomhedsnavn |
|
country |
|
(string) |
Bruger land |
|
countryCode |
|
(string) |
Bruger landekode |
|
state |
|
(string) |
Bruger state |
|
birthday |
|
(string) (dd/mm/yyyy) |
Bruger fødselsdag |
|
newsletter |
|
(boolean) |
Skal bruger tilmeldes nyhedsbrev |
|
interestGroups |
|
(int) eller (array) |
Id på bruger interessegrupper |
|
userGroup |
|
(int) |
Id på brugergruppe |
- /actions/user/edit (rediger bruger) eller () - POST endpoint
|
Parameter |
Påkrævet |
Værdi |
Beskrivelse |
|---|---|---|---|
|
firstname |
× |
(string) |
Bruger fornavn |
|
lastname |
× |
(string) |
Bruger efternavn |
|
address |
× |
(string) |
Bruger adresse |
|
zipcode |
× |
(string) |
Bruger postnummer |
|
city |
× |
(string) |
Bruger bynavn |
|
|
× |
(string) |
Bruger email |
|
password |
× |
(string) |
Bruger kodeord |
|
passwordConfirmation |
× |
(string) |
Bruger kodeord bekræftelse |
|
vatNumber |
(afhængig af indstilling) |
(string) |
Bruger/virksomheds CVR |
|
eanNumber |
(afhængig af indstilling) |
(string) |
Bruger/offentlig EAN |
|
phone |
(afhængig af indstilling) |
(string) |
Bruger telefonnummer |
|
mobilephone |
|
(string) |
Bruger mobilnummer |
|
company |
|
(string) |
Bruger/virksomhedsnavn |
|
country |
|
(string) |
Bruger land |
|
countryCode |
|
(string) |
Bruger landekode |
|
state |
|
(string) |
Bruger state |
|
birthday |
|
(string) (dd/mm/yyyy) |
Bruger fødselsdag |
|
newsletter |
|
(boolean) |
Skal bruger tilmeldes nyhedsbrev |
|
interestGroups |
|
(int) eller (array) |
Id på bruger interessegrupper |
|
interestGroupsOff |
|
(int) eller (array) |
Id på bruger interessegrupper |
- /actions/user/editpassword (rediger bruger kodeord) - POST endpoint
|
Parameter |
Påkrævet |
Værdi |
Beskrivelse |
|---|---|---|---|
|
passwordOld |
× |
(string) |
Bruger kodeord |
|
passwordNew |
× |
(string) |
Nye bruger kodeord |
|
passwordNewConfirm |
× |
(string) |
Nye bruger kodeords bekræftelse |
- /actions/user/editemail (rediger bruger email) - POST endpoint
|
Parameter |
Påkrævet |
Værdi |
Beskrivelse |
|---|---|---|---|
|
|
× |
(string) |
Bruger email |
|
password |
× |
(string) |
Bruger kodeord |
|
passwordConfirm |
× |
(string) |
Bruger kodeords bekræftelse |
- /actions/user/passwordsend (tilsend nyt kodeord) - POST endpoint
- /actions/user/passwordrecover (tilsend nyt kodeord) - POST endpoint
|
Parameter |
Påkrævet |
Værdi |
Beskrivelse |
|---|---|---|---|
|
|
× |
(string) |
Bruger email |
- /actions/user/remove (anmod om sletning af bruger) - GET endpoint
|
Parameter |
Påkrævet |
Værdi |
Beskrivelse |
|---|---|---|---|
|
|
|
|
|