API dla programistów

Dokumentacja
sklepowa
Automater.pl
prostaintegracjasklepowa
dokumentacjasklepowawersja0.1
Automatersp.zo.o.,ul.Belgradzka4/42,02-793Warszawa
0.2
2
1.Wstęp
SystemAutomater.pludostępniamożliwośćsprzedażyproduktówiodbieraniapłatności
przeznajpopularniejszychpolskichizagranicznychpośrednikówpłatności.Abyjak
najbardziejuprościćsprzedażproduktówKlientmożewypełnićformularzzakupowy
jeszczenastronieSprzedawcy,anastępniezostanieodrazuprzekierowanynastronę
płatności,np.PayPal,DotPayczyTransferuj.
2.Dodawanieproduktówdosystemu
AbyrozpocząćsprzedażproduktówcyfrowychprzezwłasnąstronęWWWnależydodać
sprzedawaneproduktydosystemu:
1. dodaniekodówlubplikówdosprzedażydobazkodów
a. zakładkaBazykodów->dodajnowąbazę
2. konfiguracjametodpłatności
a. zakładkaProdukty->metodypłatności
3. dodanieproduktów,konfiguracjaipołączenieichzbazami
a. zakładkaProdukty->listaproduktów->dodajnowyprodukt
3.Identyfikatorymetodpłatnościiproduktów
Identyfikatory produktów i metod płatności, które należy przekazywać w formularzach
znajdują się w pierwszej kolumnie tabeli.
4.PrzykładowyformularzHTML
PrzykładowyformularzwjęzykuHTMLktóryrozpocznietransakcjeonastępujących
parametrach:
• adrese-mailklienta:[email protected]
• identyfikatorproduktu:11
• identyfikatormetodypłatności:33
• ilośćsztukproduktu:3
<form action="https://automater.pl/shop/create" method="POST">
<input type="hidden" name="listing_id" value="11">
<input type="hidden" name="connector_id" value="33">
<input type="text" name="mail" value="[email protected]">
<input type="text" name="quantity" value="3">
</form>
3
3.Tworzenienowejtransakcji
Transakcjemogązostaćutworzonetylkodlaproduktów,którezostaływcześniejdodane
dosklepu.Należ
4.1Żądanie
Abyutworzyćnowątransakcjeiprzekierowaćklientadopłatnościnależyprzesłać
żądaniePOSTpodadres:
https://automater.pl/shop/create
PolaprzesyłanemetodąPOSTpowinnyzawierać:
Nazwapola
Wymagane
Opis
listing_id
tak
Identyfikatorproduktudlaktórego
transakcjamazostaćrozpoczęta
connector_id
tak
Identyfikatormetodypłatnościprzezktórą
mazostaćdokonanapłatnośćzazakupiony
produkt
mail
tak
Adresmailowyklienta,jesttorównież
adresnaktórymajązostaćwysłanekody
quantity
nie
domyślnie:1
zakres:1-1000
Ilośćzakupionychsztuk
phone
nie
domyślnie:brak
Numertelefonuklienta,używanynp.do
wysyłkikodunaSMSjeśliwybranotaką
opcję
language
nie
domyślnie:EN
Wersjajęzykowawiadomościi
powiadomieńdlaklienta,możliwe
wartości:
EN–angielski
PL-polski
return_success
nie
domyślnie:brak
AdresURLnaktóryma
zostaćprzekierowanyklientpopoprawnie
zrealizowanejpłatności
return_error
nie
domyślnie:brak
AdresURLnaktóryma
zostaćprzekierowanyklientpo
negatywniezrealizowanejpłatności
4
4.2Odpowiedź
Naprzesłaneżądanieserwerodpowiezależnieodrezultatu.
4.2.1Transakcjastworzonaprawidłowo
Popoprawnejwalidacjiistworzonejtransakcjiużytkownikwtlezostanie
przekierowanynastronępośrednika,gdziebędziemusiałdokonaćpłatności,np.PayPal
lubDotPay.Pozrealizowaniupłatności,zależnieodjejrezultatu,użytkownikzostanie
przekierowanynaadresprzekazanywparametrzereturn_successlubreturn_error.
4.2.2Błądprzytworzeniutransakcji
Wprzypadkuproblemuprzytworzeniunowejtransakcjiużytkownikzostanie
przekierowanynaadresznagłówkaHTTPREFERER,czyliadresnaktórymznajdujesię
formularz.
Doadresuzostanądoklejone2parametry,któreskryptpostronieSprzedawcymoże
zinterpretować:
• automater_error_code–kodbłędu
• automater_result–zakodowanabase64tablicawformacieJSONzawierająca2
elementy:
o code–kodbłędu
o msg–treśćbłędu
o opcjonalnie:validation–wprzypadkubłędnejwalidacjiformularza
Kody błędów:
Kod błędu
10
11
12
Opis
Błąd walidacji formularza: nieprawidłowy adres e-mail (mail) bądź ilość
zakupionych sztuk (quantity) nie znajduje się w przedziale od 1 do 100
Nie odnaleziono produktu o ID przekazanym w parametrze listing_id lub
przekazany identyfikator jest nieprawidłowy
Nie odnaleziono metody płatności o ID przekazanym w parametrze
connector_id bądź przekazany identyfikator jest nieprawidłowy