Podoba URL

Struktura URL

Úvodní URL je:

https://api.tipmoto.com/index.{format}

{format} je z podporovaných formátů

Následují výpis všech firem (pro tuto část je již nutné být přihlášený!):

https://api.tipmoto.com/c.{format}

A dále pak exporty struktur, které jsou přístupné volně

https://api.tipmoto.com/lists.{format}

URL s daty firmy mají následně zhruba tento formát:

https://api.tipmoto.com/c/{ID firmy}.{format}

https://api.tipmoto.com/c/{ID firmy}/{agenda}.{format}

https://api.tipmoto.com/c/{ID firmy}/{agenda}/{ID záznamu}.{format}

{ID firmy} je z identifikátor firmy
{agenda} je agendou, jejíž data chcete zpracovat (např. moto) - vyšší úroveň má seznam agend
{ID záznamu} je konkrétní identifikátor záznamu
{format} je z podporovaných formátů

URL parametry

API podporuje mnoho URL parametrů a na této stránce jejich souhrn. V popisu agendy pak naleznete, které operace jsou podporovány

URL parametr	Poznámka	Fukčnost
`?dry-run=true`	Testovací uložení (dry-run)	dle agendy
`?fail-on-warning=true`	Pokud nastane varování, neukládej záznam, ale selži (Validace dat)	dle agendy
`?detail=full`	Definice úrovně detailu	dle agendy
`?limit=100`	Stránkování	dle agendy
`?start=10`	Stránkování	dle agendy
`?add-row-count=true`	Přidání celkového počtu záznamů do výstupu (Stránkování)	dle agendy
`?order=nazev`	Řazení záznamů	dle agendy
`?filter=filtr`	Filtrování záznamů	dle agendy
`?fulltext=fultext &ftx-op= &ftx-loc=`	Fulltextové vyhledávání	agenda `moto`, `dily`, `prislusenstvi`
`?c=IDfirmy`	Filtrování číselníku dle firmy	dle agendy
`?cagenda=agenda`	Filtrování číselníku dle firmy a agendy	dle agendy
`?html=false`	Odstraní případné HTML kódování v datech, kde je podporováno.	všude
`?no-http-errors=true`	Pokud nastane při zpracování požadavku chyba typu 4xx, server stejně pošle 200 OK	všude
`?code-in-response=true`	V odpovědi bude u každého objektu HTTP kód.	všude
`?no-http-location=true`	Při vytvoření nového záznamu není zaslána HTTP hlavička `Location` s odkazem na vytvořený záznam.	dle agendy
`?raw-data=true`	Do struktury `photo` zasíláme místo XML rovnou JPG. (Fotky)	agenda `photo`
`?xpath=xPath`	XML se zpracuje přes zadaný xPath	všude nad GET mimo chyby
`?sessionid=1234567890`	Použije se zadaná session (Autorizace)	všude
`?lang=en`	Přepne výstupy API do angličtiny (pouze vysvětlivky a hlášky, nikoliv názvy struktur či data)	všude
`?login=login`	Alternativní metoda autorizace	agenda `gethash`
`?password=heslo`	Alternativní metoda autorizace	agenda `login`
`?usrval-show=nazev,1`	Vypíše pouze konkrétní uživatelsky definovatelná pole	agenda `moto`, `dily`, `prislusenstvi`
`?set-url=url`	Nastavení URL pro inzeráty	agenda `moto`, `dily`, `prislusenstvi`
`?action=delete`	Smazání hooku	agenda `hook`, `listhook`
`?url=url &agenda=agenda &format=format &ąmp;method=method &secKey=secKey`	Přidání hooku	agenda `hook`, `listhook`

Interně systém pracuje s formátem XML a zbylé formáty (JSON, HTML) jsou z/do XML převáděny.