Kuponi: API - Specifikacija

Grupa: Kuponske operacije

Za API pozive je potrebno da koristite korisnički token (accountToken) koji vam dodijeljuje davalac usluge. Za korisnički token se vežu posebne privilegije u odnosu na grupu API poziva.

Odgovor na API poziv sadrži JSON formatiran zapis: vrijeme, poruku, HTTP status i putanju. Poruka iz odgovora (message atribut) sadrži više detalja o uspješnom odgovoru ili upućuje na kontekst moguće greške.

U opisima parametara sa zvjezdicom su naznačeni obavezni parametri.

Kuponi

Izrada i aktivacija kupona

POST https://preko.edostava.me/api/v1.0/coupons

Poziv omogućava izradu i aktivaciju kupona. Kuponi se izrađuju na osnovu tipa kupona koji se proslijeđuje prilikom poziva (na primjer: couponType=DOPUNA5). Kupon može opcionalno da se aktivira u istom pozivu ukoliko je odredište aktivacije proslijeđeno kao parametar poziva (na primjer: redeemTarget=00-e1). Za produkcionu upotrebu koristiti parametar dryRun=false, kako bi poziv imao produkciono upisno dejstvo.

Tip kupona (couponType) trenutno može da uzima jednu od vrijednosti: DOPUNA5, DOPUNA10, DOPUNA15 ili DOPUNA20.

Odredište za aktivaciju (redeemTarget) kupona trenutno podržava samo korisnički račun kao odredište.

Poruka odgovora na uspješan poziv sadrži: broj kupona, vrijednost kupona u EUR centima i hash broj kupona. Hash broj kupona je kasnije potreban u slučaju eventualnog poništavanja izrađenog kupona.

Query Parameters

Name	Type	Description
accountToken*	string	Korisnički token za autorizaciju servisa
couponType*	string	Tip kupona
redeemTarget	string	Broj korisničkog računa na koji se aktivira kupon
dryRun	boolean	Uvijek se podrazumjeva rad na suvo - dryRun=true. Staviti vrijednost false za produkcionu upotrebu.

201: Created Kupon uspješno izrađen/aktiviran.

{
  "timestamp":"2021-10-22T08:00:00.000000+02:00",
  "message":"123-XXXX-XXX 500 e6537bcaea9d64e0cfaf6fa8eb71cfacd2d0dcc6643e2c35bb785a82958e2cc7",
  "status":200,
  "path":"/api/v1.0/coupons",
  "method":"POST"
}

401: Unauthorized Niste autorizovani.

{
..
 "message":"...",
..
}

400: Bad Request Neispravan zahtjev.

{
..
 "message":"...",
..
}

404: Not Found Resurs nije pronađen.

{
..
 "message":"...",
..
}

500: Internal Server Error Interna serverska greška.

{
..
 "message":"...",
..
}

Poništavanje izrađenih kupona

PATCH https://preko.edostava.me/api/v1.0/coupons/invalidate

Poziv omogućava poništavanje prethodno izrađenih kupona. Kupon je moguće poništiti isključivo ukoliko još nije aktiviran na korisničkom računu. Za produkcionu upotrebu koristiti parametar dryRun=false, kako bi poziv imao produkciono upisno dejstvo.

Hash broj kupona je podatak koji se dobija prilikom izrade kupona.

Razlog poništenja je opcionalan parametar i može da sadrži više detalja koji ukazuju na kontekst poništenja.

Query Parameters

Name	Type	Description
accountToken*	string	Korisnički token za autorizaciju servisa
couponCodeHash*	string	Hash broj kupona
ivalidationReason	string	Razlog poništenja kupona
dryRun	boolean	Uvijek se podrazumjeva rad na suvo - dryRun=true. Staviti vrijednost false za produkcionu upotrebu.

200: OK Kupon je poništen

{
  "timestamp":"2021-10-22T08:00:00.000000+02:00",
  "message":"invalidated",
  "status":200,
  "path":"/api/v1.0/coupons",
  "method":"PATCH"
}

400: Bad Request Neispravan zahtjev.

{
..
 "message":"...",
..
}

401: Unauthorized Niste autorizovani.

{
..
 "message":"...",
..
}

404: Not Found Resurs nije pronađen.

{
..
 "message":"...",
..
}

500: Internal Server Error Interna serverska greška.

{
..
 "message":"...",
..
}