Komunikace probíhá prostřednictvím protokolu HTTP. Vstupní bod pro komunikaci je http://www.rajce.idnes.cz/liveAPI/index.php. Požadavky se posílají metodou POST v položce jménem "data".
Příklad vrácené chyby:
<?xml version="1.0" encoding="utf-8"?> <response> <result>Chybný přihlašovací token.</result> <errorCode>4</errorCode> </response>
Přihlášení k rajčeti. Za základě přihlášení dostanete sessionToken, který dále používáte pro komunikaci s rajčetem. Většina ostatní API funkcí též vrací sessionToken, který nahrazuje ten původní. Princip podobný cookies.
Vylistuje seznam svých alb.
Vylistuje seznam alb jiného uživatele – pouze viditelná alba (a veřejné údaje).
Zjistí základní informace o jednom albu - pouze viditelná alba (a veřejné údaje), pokud není uveden token majitele alba.
Pomocí columns lze zvolit požadované "sloupce" (údaje) a zmenšit tak množství přenášených dat. ThumbUrl obsahuje url předgenerovaného náhledu (nejrychlejší přístup i při velkém množství requestů - např. stažení náhledů všech fotek alba). ThumbUrlBest obsahuje url většího náhledu, který je cachovaný, ale jinak generovaný na přání. UrlBase pak obsahuje začátek url, pomocí které si můžeme nechat obrázek vygenerovat na přání - tedy zvolit rozměr a míru jpeg komprese. Stačí na konec doplnit tyto údaje, např.:
http://www.rajce.idnes.cz/f202525196-7a2782d3/ ... s výchozím nastavení (doporučeno)
http://www.rajce.idnes.cz/f202525196-7a2782d3/500px ... fotka vepsaná do čtverce 500 x 500 px
http://www.rajce.idnes.cz/f202525196-7a2782d3/500px/q50 ... fotka vepsaná do čtverce 500 x 500 px s jpeg kvalitou 50%
Generování na přání používat jen v případě nutnosti (např. mobilní zařízení).
V případě cizího alba funguje pouze pro veřejná alba.
Nástěnku lze otevřít zadáním albumID = 0.
MIME Multipart. Další informace o fotce - konzultujte.
Content-Disposition: form-data; name="thumb"; filename="cokoli"
Content-Type: image/jpeg
Náhled 100x100 px
Content-Disposition: form-data; name="photo"; filename="cokoli"
Content-Type: image/jpeg
Zmenšená fotka
Po dokončení přidávání fotek do alba.
Po dokončení přidávání fotek.
Získá adresu stránky, kde lze vytvořit nový účet.
Získá url stránky, kde si lze nechat obnovit zapomenuté heslo.
Parametr "target" může nabývat hodnot:
- user-profile (uživatelský profil - nastavení)
- email-notifications (e-mailové notifikace - nastavení)
- service-notifications (notifikace do různých služeb, např. Facebook - nastavení)
Maže album přihlášeného uživatele.
Započne nové nahrávání videa nebo naváže na předchozí nedokončený upload (v takovém případě je třeba uvést stejné clientVideoID).
Nahraje několik bloků videa - tedy při uploadu videa se tato metoda volá opakovaně tak, aby jeden požadavek na server trval rozumnou dobu.
Vlastní data bloků musí být v POST položkách data[blockIndex], tedy např. data2, data3 s context-typem application/octet-stream (položky také musí obsahoval libovolný filename, viz příklad u příkazu addPhoto), přičemž celý požadavek bude MIME Multipart.
Pokusí se dokončit upload videa.
Náhled videa v rozlišení výsledného videa v POST položce "image", náhled vepsaný do čtverce 100x100px v položce "thumb" s context-typem image/jpeg, přičemž celý požadavek bude MIME Multipart. Náhledy jsou ve formátu JPEG.
Vyhledá uživatele (fulltext).
Vyhledá uživatele (fulltext).
Získá seznam oblíbených uživatelů přihlášeného nebo jiného uživatele.
Získá seznam oblíbených alb přihlášeného nebo jiného uživatele.
Získání informací o jednom konkrétním uživateli.
Získání seznamu nej(lepších?) fotek.
Přidání uživatele do seznamu oblíbených.
Přidání uživatele do seznamu oblíbených.
Přidání aba do seznamu oblíbených alb.
Odebrání alba ze seznamu oblíbených.
Získá seznam kategorií alb (zatím jen těch základních - bez soutěží apod.).
Získá seznam alb v dané kategorii (výchozí řazení - od nejnovějšího, jiné nyní není k dispozici). Nelze procházet všemi alby (počet je omezen např. na 1000).
Maže fotku přihlášeného uživatele.
Kód | Text chyby |
---|---|
1 | Neznámá chyba. |
2 | Neplatný příkaz. |
3 | Chybné přihlašovací údaje. |
4 | Chybný přihlašovací token. |
5 | Neznámý nebo opakující se sloupec {colName}. |
6 | Není uvedeno správné albumID. |
7 | Album neexistuje nebo není přihlášeného uživatele. |
8 | Chybný token alba. |
9 | Album nemůže mít prázdné jméno. |
10 | Nepodařilo se vytvořit album. (těžko říct, proč ... asi chyba na straně serveru) |
11 | Album neexistuje. |
12 | Neexistující aplikace. |
13 | Chybný klíč aplikace. |
14 | Není přiložený soubor. |
15 | Již existuje novější verze {version}. |
16 | Chyba při ukládání souboru. |
17 | Nepovolená přípona souboru {extension}. |
18 | Chybné číslo verze klienta. |
19 | Neexistující cíl (target). |
20 | Chybí jméno k ochraně alba. |
21 | Chybí heslo k ochraně alba. |
22 | Chyba komunikace - dorazil prázdný soubor. |
23 | Některé bloky videa chybí. |
24 | Uživatel neexistuje. |
25 | Není uvedeno správné userID ani albumID. |
26 | Album neexistuje nebo není přihlášeného uživatele ani veřejné. |
27 | Chybný clientVideoID. |
28 | Upload s daným číslem neexistuje. |
29 | Chybné favUserID. |
30 | K albu nyní nelze z technických důvodů přistupovat pro zápis. Opakujte pokus později. |
31 | Příliš mnoho neúspěšných pokusů o přihlášení - zkuste to za chvíli. |
32 | Album neexistuje nebo není přihlášeného uživatele. |