Ta API je za zagotavljanje kode kupona Slevomat.cz, potem ko stranka plača naročilo za posel. Običajno Slevomat.cz ustvari lastno kodo kupona, vendar z uporabo tega API-ja lahko našega poslovnega partnerja obvestimo o naročilu in ustvarimo lastno kodo kupona po meri za stranko.
Vse zahteve se izvajajo prek protokola HTTPS (ki zahteva, da strežnik poslovnega partnerja podpira HTTPS in ima veljaven certifikat) in vsi podatki morajo biti oblikovani kot JSON .
Dnevnik sprememb
01. 03. 2017 – dodan razdelek obravnavanje neveljavnih zahtev
10. 02. 2017 – začetna verzija
Omogočanje API-ja
Vse zahteve opravi aplikacija Slevomat.cz, ki pošlje zahtevo na strežnik partnerja. Zahteva bo vsebovalaX-RequestToken Glava HTTP s skrivnim nizom. Ta niz mora preveriti partnerjev strežnik , da se zagotovi varnost. Ta skrivni niz poznata samo Slevomat.cz in partner.
Če želite omogočiti API, mora partner vprašati Slevomat.cz in zagotoviti URL, kjer bo API, na primer:
https://example.com/slevomat-external-voucher-code/generate
Ko Slevomat.cz omogoči API za partnerja in mu daX-RequestToken vrednosti, je samo v testnem načinu, kar pomeni, da nobeno pravo naročilo ne bo izvedlo zahteve za pridobitev kode kupona po meri. Partnerju pa omogoča, da razvije in preizkusi API na svojem strežniku s priloženimX-RequestToken vrednost.
Ko bo API na partnerjevem strežniku razvit in testiran, bo Slevomat.cz preklopil način na realna naročila. Naročila za posle, ki so se začela prodajati po zamenjavi, bodo zahtevala partnerjev API za kode bonov po meri.
Ustvarjanje kode bona
Ko je naročilo za posel plačano, bo Slevomat.cz poslal POST zahtevo partnerjevemu strežniku za generiranje kode vavčerja in partnerju dal nekaj informacij o naročilu. Ta zahteva bo poslana posebej za vsako prodano enoto.
Zahteva vsebuje zahtevano predpono kode kupona. Ustvarjena koda bona se mora začeti s to predpono .
Telo zahteve bo videti takole:
{ "uuid": "91987a73-095c-4b94-bd38-f6ffd4ab86a7", "deal": { "product_id": 123, "product_name": "Aktivní dovolená: 4 až 6 dní s all inclusive v Rakousku. 2 děti do 8,9 let zdarma!", "variant_id": 456, "variant_name": "1 osoba | 4 dny (3 noci) | Období So 13. 5. – So 24. 6. 2017, Ne 27. 8. – Ne 5. 11. 2017" }, "customer": { "email": "cu******@ex*****.com" }, "voucherCodePrefix": "LIN", "repeatReason": 1 }Strežnik se mora odzvati s statusno kodo HTTP 200, telo odgovora z ustvarjeno kodo kupona pa mora izgledati takole:
{ "voucherCode": "LIN1234567890" }Strežnik se mora odzvati v 10 sekundah , sicer je zahteva označena kot neuspešna. Ustvarjena koda bona se mora začeti z dano predpono in mora biti edinstvena. Obstajajo tudi drugi razlogi, zakaj morda ne sprejmemo ustvarjene kode kupona.
Ko zahteva ni uspešna, se ponovi z razlogom vrepeatReason polje, dokler ni uspešno. To polje bo vsebovalo eno od naslednjih vrednosti:
| Ponovi razlog | Opis |
|---|---|
| 1 | Prvi poskus. |
| 2 | Povezava s strežnikom ni bila uspešna. To lahko pomeni neveljavno potrdilo HTTPS ali da omrežje ni delovalo. |
| 3 | Strežnik se ni pravočasno odzval. |
| 4 | Strežnik se je odzval s statusno kodo HTTP, ki ni 200. |
| 5 | Strežnik je odgovoril s HTTP 200, vendar telo odgovora ni vsebovalo JSON ali pa JSON ni vseboval ključa voucherCode. |
| 6 | Ustvarjena koda kupona ni vsebovala zahtevane predpone. |
| 7 | Ustvarjena koda kupona je vsebovala neveljavne znake. Samo veljavni znaki so:[a-zA-Z0-9-]+ . |
| 8 | Ustvarjena koda bona ni bila edinstvena. |
Telo zahteve bo vedno vsebovalo istouuid identifikator kot prejšnja zahteva za generiranje kode kupona za isto naročilo stranke.
Obravnava neveljavne zahteve
Ko se pojavi zahteva, ki ne izpolnjuje varnostnih zahtev, tj. vsebuje neveljavnoX-RequestToken , se mora strežnik odzvati s kodo HTTP 403 Prepovedano.
Testiranje implementacije API-ja
Prijavite se kot naš partner, da vidite svoje stanje API-ja ter preizkusite in preverite svojo implementacijo API-ja.