API dokumentace

Obecný popis

API slouží k zasílání poptávek a objednávek do vašeho systému. Pokud hledáte import produktů, naleznete jej v XML dokumentaci.

API může odesílat POST požadavky s údaji o poptávkách a objednávkách do vašeho systému. Jediné, co je potřeba udělat je, vyplnit webhook endpointy pro zasílání a připravit zpracování ve vašem systému. Endpoint vyplníte ve své administraci na této stránce.

Autorizace

Autorizace probíhá pomocí API klíče a jména zakódovaného přes base64 v hlavičce jako Basic authorization.

API klíč nalezente ve svém účtu v záložce Propojení.
API jméno je pro všechny požadavky stejné a je to "edukomforta"

Jestli autorizaci budete kontrolovat na vaší straně je už na vašem rozhodnutí.

Poptávky

Poptávky se odesílají na URL vámi zvolené v administraci s následujícími položkami v body:

first_name	Jméno žadatele
last_name	Příjmení žadatele
email	Emailová adresa
phone	Telefon
product_id	ID produktu
product_title	Název produktu
enquiry_id	Naše interní ID poptávky
time	UNIX timestamp časová známka
term_id	Interní ID vybraného termínu
term_title	Zvolený název vybraného termínu
term_date	Datum konání termínu formát YYYYMMDD
term_address	Adresa termínu

Založení objednávky

Objednávky se posílají po vytvoření nehledě na to, jestli je poptávka zaplacená či nikoliv. V tělě POST požadavku naleznete následující pole:

pid	Naše interní ID produktu
url	URL produktu
name	Název produktu
quantity	Objednané množství
vat_rate	Sazba DPH
price	Cena bez DPH za jeden produkt
price_vat	Cena s DPH za jeden produkt
vat	DPH za jeden produkt
total_price	Celkem cena za všechny produkty bez DPH
total_price_vat	Celkem cena za všechny produkty s DPH
price_group_discount_index	Index slevy cenové skupiny. Všechny ceny výše uvedené jsou již po aplikaci indexu. Např. hodnota 0.9 je 10% sleva.
note	Poznámka k objednávce
participants	Pole účastníků kurzu/zkoušky ve formátu:
term	Informace o termínu ve formátu:

Zaplacení objednávky

Po zaplacení objednávky se zasílá pouze naše interní ID objednávky. Systém inzerenta by si již měl napárovat předešlé založené nákupy na toto ID.

order_id

Naše interní ID objednávky