API

PodaciListek.cz poskytuje možnost vyplňování podacích lístků za pomocí API. Přenos dat je realizován pomocí protokolu HTTP.

  • Typ požadavku - Požadavek je nutno odeslat pomocí protokolu HTTP pod hlavičkou POST.
  • Formát dat - Požadavek na PodaciListek.cz API je nutno zasílat ve formátu JSON.

Adresa API

Podací lístek verze 1

Struktura

Příklad získání prázdného lístku

curl -v -X POST -H "Content-type: application/json" -d '' http://api.podacilistek.cz/v1 > ~/file.pdf

Příklad požadavku pro vyplnění 1 podacího lístku v1:

{"tickets": 
  {"1": 
    {"sender": 
      {"name": "jméno odesilatele", 
       "street": "ulice odesilatele", 
       "post_code": "poštovní směrovací číslo odesilatele", 
       "city": "město odesilatele"}, 
    "receiver": 
      {"name": "jméno příjemce", 
       "street": "ulice příjemce", 
       "street2": "ulice2 příjemce", 
       "post_code": "poštovní směrovací číslo příjemce", 
       "city": "město příjemce"}, 
       "cash_on_delivery": "200", 
       "declared_cash": "200"} } }
tickets
skupina podacích lístků
1
označuje pořadové číslo lístku
sender
odesilatel - skupina údajů o odesilateli
receiver
příjemce - skupina údajů o příjemci
name
jméno na podacím lístku
street
ulice na podacím lístku
street2
ulice na podacím lístku - pouze u příjemce
post_code
poštovní směrovací číslo na podacím lístku
city
město na podacím lístku
cash_on_delivery
dobírka v Kč na lístku
declared_cash
uvedená cena v Kč na lístku

Příklad

API
API
API

Podací lístek verze 2

Struktura

Příklad získání prázdného lístku

curl -v -X POST -H "Content-type: application/json" -d '' http://api.podacilistek.cz/v2 > ~/file.pdf

Příklad požadavku pro vyplnění 2 podacího lístku v2:

{"tickets": 
  {"1": 
    {"sender": 
      {"name": "jméno odesilatele", 
       "street": "ulice odesilatele", 
       "post_code": "poštovní směrovací číslo odesilatele", 
       "city": "město odesilatele",
       "phone": "123456789",
       "e-mail": "e-mail_odesilatele@adresa.com",
       "code": "12312"}, 
     "receiver": 
      {"name": "jméno příjemce", 
       "street": "ulice příjemce", 
       "street2": "ulice2 příjemce", 
       "post_code": "poštovní směrovací číslo příjemce", 
       "city": "město příjemce",
       "phone": "123456789",
       "e-mail": "e-mail_prijemce@adresa.com",
       "code": "12312"}, 
       "cash_on_delivery": "200", 
       "declared_cash": "200"} } }
tickets
skupina podacích lístků
1
označuje pořadové číslo lístku
sender
odesilatel - skupina údajů o odesilateli
receiver
příjemce - skupina údajů o příjemci
name
jméno na podacím lístku
street
ulice na podacím lístku
street2
ulice na podacím lístku - pouze u příjemce
post_code
poštovní směrovací číslo na podacím lístku
city
město na podacím lístku
phone
telefonní číslo pro avízo
e-mail
e-mail pro avízo
code
kód zákazníka
cash_on_delivery
dobírka v Kč na lístku
declared_cash
uvedená cena v Kč na lístku

Příklad

API
API
API

Podací lístek verze 3

Struktura

Příklad získání prázdného lístku

curl -v -X POST -H "Content-type: application/json" -d '' http://api.podacilistek.cz/v3 > ~/file.pdf

Příklad požadavku pro vyplnění 3 podacího lístku v3:

{"tickets": 
  {"sender": 
    {"name": "jméno odesilatele", 
     "street": "ulice odesilatele", 
     "post_code": "poštovní směrovací číslo odesilatele", 
     "city": "město odesilatele",
     "phone": "123456789",
     "e-mail": "e-mail_odesilatele@adresa.com"}, 
  "1": 
    {"receiver": 
      {"name": "jméno příjemce", 
       "street": "ulice příjemce",
       "post_code": "poštovní směrovací číslo příjemce", 
       "city": "město příjemce",
       "phone": "123456789",
       "e-mail": "e-mail_prijemce@adresa.com"},
     "cash_on_delivery": "200", 
     "note": "Poznámka, doplňkové služby"} } }
tickets
skupina podacích lístků
1
označuje pořadové číslo lístku
sender
odesilatel - skupina údajů o odesilateli
receiver
příjemce - skupina údajů o příjemci
name
jméno na podacím lístku
street
ulice na podacím lístku
post_code
poštovní směrovací číslo na podacím lístku
city
město na podacím lístku
phone
telefonní číslo pro avízo
e-mail
e-mail pro avízo
cash_on_delivery
dobírka v Kč na lístku
note
poznámka k lístku

Příklad

API
API
API