RAPL - programátorská příručka

RAPL - parametry

Pro správnou práci s aplikací je nejprve nutné založit účetní klíč, který určí, jak a kam se zaúčtují platby na konferenci (např. SPP prvek, číslo účtu). Bez správného účetního klíče se nepodaří úspěšně založit novou konferenci.

Při založení nové akce (konference) je potřeba vyplnit veškeré povinné údaje, které jsou označeny hvězdičkou. Je nutné zadat správný účetní klíč. Aplikace rozpozná, zda je zadaný účetní klíč platný či neplatný. Mezi další důležité údaje patří měna, tajný kód a SPP prvek.

Zvolená měna se bude zobrazovat v platební bráně při zaplacení konference platební kartou. Tajný kód je jedinečný identifikátor akce, který je vždy potřeba uvést v odkazu pro registraci na danou konferenci. SPP prvek je možné vyplnit pro kontrolu.

Webové stránky konference musí při registraci nového účastníka vygenerovat odkaz na konferenci. Ten musí kromě adresy RAPLu obsahovat i následující parametry:

conference = tajný kód – povinný parametr
conferenceid = id konference – povinný parametr
email = e-mailová adresa účastníka, která slouží jako přihlašovací jméno – povinný parametr
firstname = jméno účastníka
surname = příjmení účastníka
institutionname = název instituce, za kterou se účastník hlásí
institutionstreet = adresa instituce - ulice
institutioncity = adresa instituce - obec
institutionzip = adresa instituce - PSČ
institutioncountry = adresa instituce - stát
price = cena konference pro účastníka
currency = měna, ve které bude účastník platit za konferenci, měla by být shodná s měnou založené konference

Po kliknutí na odkaz vytvořený na stránkách konference se účastníkovi otevře registrační formulář s předvyplněnými údaji. Účastník konference musí vyplnit pouze chybějící informace a heslo. Po uložení registračního formuláře bude ihned přihlášen do aplikace.

V případě placené konference bude uživateli po uložení registrace přidělen variabilní symbol. Zaplatit poplatek je možné ihned či později. Do aplikace se účastník může přihlásit pomocí své e-mailové adresy a hesla, které si zvolil. Účastník má k dispozici přehled všech svých registrací na konference včetně stavu plateb.

RAPL - služba

Na adrese rapl.upol.cz/service je možné volat služby pro zakládání účastníků, zjištění stavu platby (podle guid) a vytvoření odkazu na platební bránu (podle guid).

K tomuto je nutné použít metodu POST.

Akce dostupné ve službě:

CreateRegistration – založení účastníka CheckUserPayment – stav platby VS GetPaymentGateUrl – odkaz na platební bránu

Vstupní parametry:

CreateRegistration

secret – tajný kód (dodaný - podle akce)
actionid – id akce (dodané - podle akce)
firstname – jméno účastníka
surname – příjmení účastníka
email – e-mail účastníka
price – cena
returnurl – adresa, na které se očekává výsledek
paymentgatereturnurl – adresa, na kterou je účastník přesměrován po zaplacení na platební bráně
guid – jednoznačný identifikátor registrace účastníka, pokud není zadán, tak se vygeneruje sám a pošle se v odpovědi.

CheckUserPayment

guid – jednoznačný identifikátor registrace účastníka (je vrácen při registraci)

GetPaymentGateUrl

guid – jednoznačný identifikátor registrace účastníka (je vrácen při registraci)

Struktura odpovědi:

Guid - jednoznačný identifikátor registrace účastníka
PaymentGateUrl - odkaz na platební bránu
UserUrl - adresa registrace účastníka, na které si může zkontrolovat stav své platby
Success - identifikátor, zda služba proběhla v pořádku
Paid - stav zaplacení (zaúčtování v SAPu)
Promise - stav zaplacení kartou
Error - popis chyby, pokud nastala

Odpověď ve formátu JSON přijde vždy na adresu, která je zadaná v parametru returnurl, příp. je vždy vypsaná v html stránce služby.

Příklad volání:

http://rapl.upol.cz/service/CheckUserPayment?guid=77264892-9edc-47fa-adf3-e39973ac6a31&returnurl=http:// ewic2017.upol.cz/&paymentgatereturnurl=http:// ewic2017.upol.cz/