RAPL2: Porovnání verzí

Skočit na navigaci Skočit na vyhledávání
Bez shrnutí editace
Bez shrnutí editace
Řádek 1: Řádek 1:
V následujícím textu naleznete technické specifikace aplikace. Hledáte-li uživatelskou příručku, naleznete ji [[RAPL|'''zde''']].{{DISPLAYTITLE:RAPL - programátorská příručka}}
V následujícím textu naleznete technické specifikace aplikace. Hledáte-li uživatelskou příručku, naleznete ji [[RAPL|'''zde''']].
== 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.  
{{DISPLAYTITLE: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.


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.  
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:
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.  
-         '''''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==


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


== RAPL - služba ==
K volání je možné použít metodu POST i GET. Služba hledá parametry, které jsou poslány metodou POST, pokud žádné nenajde, tak zkusí najít parametry poslané metodou GET.


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).
==='''Akce dostupné ve službě:'''===
CreateRegistration – založení účastníka


K tomuto je nutné použít metodu POST.
CheckUserPayment – stav platby VS


=== '''Akce dostupné ve službě:''' ===
GetPaymentGateUrl – odkaz na platební bránu
CreateRegistration – založení účastníka  CheckUserPayment – stav platby VS GetPaymentGateUrl – odkaz na platební bránu


=== Vstupní parametry: ===
===Vstupní parametry:===


==== CreateRegistration ====
====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 ====
*secret – tajný kód (dodaný - podle akce)
* guid – jednoznačný identifikátor registrace účastníka (je vrácen při registraci)
*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.


==== GetPaymentGateUrl ====
Odpověď, kterou služba vrací je vždy stejná. Parametry jsou nastaveny podle toho, které jsou relevantní k volané službě.
* guid – jednoznačný identifikátor registrace účastníka (je vrácen při registraci)
 
===Struktura odpovědi:===


=== Struktura odpovědi: ===
* Guid - jednoznačný identifikátor registrace účastníka
* Guid - jednoznačný identifikátor registrace účastníka
* PaymentGateUrl - odkaz na platební bránu
* PaymentGateUrl - odkaz na platební bránu
* UserUrl  - adresa registrace účastníka, na které si může zkontrolovat stav své platby
* 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
* Success        - identifikátor, zda služba proběhla v pořádku
* Paid - stav zaplacení (zaúčtování v SAPu)
* PaymentState - stav zaplacení (zaúčtování v SAPu)
* Promise - stav zaplacení kartou
* Error - popis chyby, pokud nastala
* 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í: ===
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í:===
<nowiki>http://rapl.upol.cz/service/CheckUserPayment?guid=77264892-9edc-47fa-adf3-e39973ac6a31&returnurl=http://</nowiki> ewic2017.upol.cz/&paymentgatereturnurl=http:// ewic2017.upol.cz/
<nowiki>http://rapl.upol.cz/service/CheckUserPayment?guid=77264892-9edc-47fa-adf3-e39973ac6a31&returnurl=http://</nowiki> ewic2017.upol.cz/&paymentgatereturnurl=http:// ewic2017.upol.cz/
=== služba CreateRegistrationAndPay ===
Služba provede registraci účastníka a v případě úspěšné registrace přesměruje na platební bránu. Po zaplacení je účastník přesměrován na adresu, která je uvedena v parametru ''paymentgatereturnurl''. Pokud nastane chyba během registrace účastníka, nedochází k přesměrování na platební bránu, ale na adresu uvedenou v parametru ''returnurl'', do které se doplní výstupní parametry.
'''vstupní parametry:'''
{| class="wikitable"
|'''Název parametru'''
|'''Popis'''
|'''Povinný'''
|'''Typ'''
|-
|Secret
|tajný kód vygenerovaný při zakládání akce
|Ano
|String
|-
|ActionId
|id akce
|Ano
|Id
|-
|FirstName
|jméno účastníka
|Ano
|String
|-
|SurName
|příjmení účastníka
|Ano
|String
|-
|Email
|e-mail účastníka
|Ano
|String
|-
|Price
|Cena uvedená ve měně akce
|Ano
|Decimal
|-
|ReturnUrl
|adresa, ze které se volá služba
|Ano
|String
|-
|PaymentGateReturnUrl
|adresa, na kterou je účastník přesměrován po zaplacení na  platební bráně
|Ano
|String
|-
|Uid
|jednoznačný identifikátor registrace účastníka, pokud není  zadán, tak se vygeneruje sám a pošle se v odpovědi
|Ne
|String
|-
|ExternalId
|Externí id registrace
|Ne
|String
|-
|InstitutionName
|Název instituce účastníka
|Ne
|String
|-
|InstitutionStreet
|Adresa instituce účastníka
|Ne
|String
|-
|InstitutionCity
|Město instituce účastníka
|Ne
|String
|-
|InstitutionZip
|PSČ instituce účastníka
|Ne
|String
|-
|InstitutionCountry
|Stát instituce účastníka
|Ne
|String
|}
'''výstupní parametry:'''
{| class="wikitable"
|'''Název parametru'''
|'''Popis'''
|'''Typ'''
|-
|Error
|Slovní popis chyby
|String
|-
|UserUrl
|Cesta k registraci účastníka
|String
|-
|PaymentGateUrl
|Adresa pro  platbu na platební bráně v Base64. Lze použít pouze jednou, pro každou  další platbu je nutné vygenerovat novou adresu službou GetPaymentGateUrl
|String
|-
|Success
|Identifikátor úspěšnosti služby
|Bool
|}
=== Služba CreateRegistrationAndReturn ===
Služba provede registraci účastníka a přesměruje na adresu uvedenou v parametru ''returnurl'', do které se doplní výstupní parametry.
'''vstupní parametry:'''
{| class="wikitable"
|'''Název parametru'''
|'''Popis'''
|'''Povinný'''
|'''Typ'''
|-
|Secret
|tajný kód vygenerovaný při zakládání akce
|Ano
|String
|-
|ActionId
|id akce
|Ano
|Id
|-
|FirstName
|jméno účastníka
|Ano
|String
|-
|SurName
|příjmení účastníka
|Ano
|String
|-
|Email
|e-mail účastníka
|Ano
|String
|-
|Price
|Cena uvedená ve měně akce
|Ano
|Decimal
|-
|ReturnUrl
|adresa, ze které se volá služba
|Ano
|String
|-
|PaymentGateReturnUrl
|adresa, na kterou je účastník přesměrován po zaplacení na  platební bráně
|Ano
|String
|-
|Uid
|jednoznačný identifikátor registrace účastníka, pokud není  zadán, tak se vygeneruje sám a pošle se v odpovědi
|Ne
|String
|-
|ExternalId
|Externí id registrace
|Ne
|String
|-
|InstitutionName
|Název instituce účastníka
|Ne
|String
|-
|InstitutionStreet
|Adresa instituce účastníka
|Ne
|String
|-
|InstitutionCity
|Město instituce účastníka
|Ne
|String
|-
|InstitutionZip
|PSČ instituce účastníka
|Ne
|String
|-
|InstitutionCountry
|Stát instituce účastníka
|Ne
|String
|}
'''výstupní parametry:'''
{| class="wikitable"
|'''Název parametru'''
|'''Popis'''
|'''Typ'''
|-
|Error
|Slovní popis chyby
|String
|-
|UserUrl
|Cesta k registraci účastníka
|String
|-
|PaymentGateUrl
|Adresa pro  platbu na platební bráně v Base64. Lze použít pouze jednou, pro každou  další platbu je nutné vygenerovat novou adresu službou GetPaymentGateUrl
|String
|-
|Success
|Identifikátor úspěšnosti služby
|Bool
|}
=== Služba CheckUserPayment ===
Služba ověří stav platby účastníka.
'''vstupní parametry:'''
{| class="wikitable"
|'''Název parametru'''
|'''Popis'''
|'''Povinný'''
|'''Typ'''
|-
|ExternalId
|Jednoznčné externí ID registrace účastníka
|Ano
|String
|-
|SecretHash
|jednoznačný identifikátor akce – tajný nikde neuváděný (při  registraci)
|Ano
|String
|}
'''výstupní parametry, které služba vrací nastaveny:'''
{| class="wikitable"
|'''Název parametru'''
|'''Popis'''
|'''Typ'''
|-
|Error
|Slovní popis chyby
|String
|-
|PaymentState
|Stav zaplacení (0/1 – nezaplacený;  2 – zaplacený kartou; 4 – zaúčtován v SAPu)
|Int
|-
|Success
|Identifikátor úspěšnosti služby
|True/False
|}
=== Služba GetPaymentGateUrl ===
Vygeneruje odkaz na platební bránu pro jednu registraci účastníka na akci.
'''vstupní parametry:'''
{| class="wikitable"
|'''Název parametru'''
|'''Popis'''
|'''Povinný'''
|'''Typ'''
|-
|ExternalId
|Jednoznčné externí ID registrace účastníka
|Ano
|String
|-
|SecretHash
|jednoznačný identifikátor akce – tajný nikde neuváděný (při registraci)
|Ano
|String
|}
'''výstupní parametry, které služba vrací nastaveny:'''
{| class="wikitable"
|'''Název parametru'''
|'''Popis'''
|'''Typ'''
|-
|Error
|Slovní popis chyby
|String
|-
|PaymentGateUrl
|Vygenerovaný odkaz na platební bránu
|Bool
|-
|Success
|Identifikátor úspěšnosti služby
|True/False
|}
=== Služba GetRegistrationInfo ===
Vrátí informace o registraci uživatele
{| class="wikitable"
|'''Název parametru'''
|'''Popis'''
|'''Povinný'''
|'''Typ'''
|-
|ExternalId
|Jednoznčné externí ID registrace účastníka
|Ano
|String
|-
|SecretHash
|jednoznačný identifikátor akce – tajný nikde neuváděný (při registraci)
|Ano
|String
|}
'''výstupní parametry, které služba vrací nastaveny:'''
{| class="wikitable"
| colspan="2" |'''Název parametru'''
|'''Popis'''
|'''Typ'''
|-
| colspan="2" |Error
|Slovní popis chyby
|String
|-
| colspan="2" |ActionName
|Název akce
|String
|-
| colspan="2" |ActionExternalId
|Externí Id akce
|String
|-
| colspan="2" |ExternalId
|Externí Id účastníka
|String
|-
| colspan="2" |FirstName
|Jméno účastníka
|String
|-
| colspan="2" |SurName
|Příjmení účastníka
|string
|-
| colspan="2" |Email
|E-mail účastníka
|String
|-
| colspan="2" |InstitutionName
|Název instituce
|String
|-
| colspan="2" |InstitutionStreet
|Ulice
|String
|-
| colspan="2" |InstitutionCity
|Město
|String
|-
| colspan="2" |InstitutionZip
|PSČ
|String
|-
| colspan="2" |InstitutionCountry
|Stát
|String
|-
| colspan="2" |Vs
|Variabilní symbol
|Long
|-
| colspan="2" |Price
|Cena
|Decimal
|-
| colspan="2" |Currency
|Měna
|String
|-
| colspan="2" |Success
|Identifikátor úspěšnosti služby
|Bool
|-
|PaymentState
| colspan="2" |Stav zaplacení (1 – použitý; 2 –  zaplacený kartou; 4 – zaúčtován v SAPu)
|Int
|}
Stavy po zaplacení kartou jsou popsány v dokumentaci systému GPWebPay.
<nowiki>http://gpwebpay.cz/Content/downloads/GP_webpay_Seznameni_se_systemem_072013.pdf</nowiki>
=== GetActionRegistrations ===
Služba pro vrácení informací o registrovaném účastníkovi (účastnících) podle ExternalId.
Povinné vstupní parametry: externalid, secretHash akce.
{| class="wikitable"
|'''Název parametru'''
|'''Popis'''
|'''Povinný'''
|'''Typ'''
|-
|SecretHash
|jednoznačný identifikátor akce – tajný nikde neuváděný (při  registraci)
|Ano
|String
|-
|ExternalId
|externí ID akce
|Ano
|String
|}
'''výstupní parametry:'''
{| class="wikitable"
|'''Název parametru'''
|'''Popis'''
|'''Typ'''
|-
|Error
|Slovní popis chyby
|String
|-
|RegistredUsers
|Stejná struktura jako u služby GetRegistrationInfo
|Pole
|-
|Success
|Identifikátor úspěšnosti služby
|True/False
|}
=== GetActionVariableSymbols ===
Služba pro vrácení všech variabilních symbolů k akci s identifikací zda byl zaplacen nebo ne.
Povinné vstupní parametry: SecretHash akce
{| class="wikitable"
|'''Název parametru'''
|'''Popis'''
|'''Povinný'''
|'''Typ'''
|-
|SecretHash
|jednoznačný identifikátor akce – tajný nikde neuváděný (při  registraci)
|Ano
|String
|-
|ExternalId
|externí ID akce
|Ano
|String
|}
V'''ýstupní parametry:'''
{| class="wikitable"
|'''Název parametru'''
|'''Popis'''
|'''Typ'''
|-
|Error
|Slovní popis chyby
|String
|-
|VariableSymbols
|Výčet variabilních symbol
|Pole
|-
|Success
|Identifikátor úspěšnosti služby
|True/False
|}
'''Struktura parametru VariableSymbols'''
{| class="wikitable"
|'''Název parametru'''
|'''Popis'''
|'''Typ'''
|-
|Variable
|Variabilní symbol
|Long
|-
|GenerationDate
|Datum vygenerování (ve formátu yyyy-MM-dd HH:mm:ss)
|String
|-
|PaymentState
|Stav zaplacení (1 – použitý; 2 –  zaplacený kartou; 4 – zaúčtován v SAPu)
|Int
|}
<br />
Citováno z „http:///upwiki/RAPL2“