API pro službu Mobilem.cz, verze XML 4.9

API pro službu Mobilem.cz, verze XML 4.9 Tento dokument je určen pro partnery Mobilem.cz. Není dovoleno obsah použít pro jiný účel než za jakým byl poskytnut. Všechna práva vyhrazena pro DCCI s.r.o.

Publikováno: 05.06.2006

1. Obsah 1. Obsah........................................................................................................................1 2. Volání API a identifikace pro partnerské portály.............................................................2 Obecné parametry....................................................................................................2 3. Volání API a identifikace pro aplikace............................................................................2 Identifikace partnera................................................................................................2 Autorizace uživatele v požadavku...............................................................................2 4. Formát požadavku.......................................................................................................3 Testovací parametry..................................................................................................3 Příklad zaslání požadavku ...............................................................................................................................3 5. Formát odpovědí.........................................................................................................3 status=”ok”.............................................................................................................3 status=”error”..........................................................................................................3 API pro JavaHry, mobilní obsah (loga, melodie, obrázky)...................................................5 6. Typy obsahů...............................................................................................................5 7. Podporované mobilní telefony (pouze pro hry)...............................................................5 8. Podporované mobilní telefony k obsahu........................................................................5 9. Kategorie obsahů........................................................................................................6 10. Výpis obsahu............................................................................................................6 Společné položky odpovědi........................................................................................7 Výpis telefonů podporujících listovaný obsah...............................................................8 JavaHry – contenttype „game“..................................................................................8 Melodie – contenttype „melodie“................................................................................8 Melodie – contenttype „tapeta“..................................................................................9 11. Zakoupení obsahu – získání URL.................................................................................9 Informace o platnosti URL pro download obsahu.......................................................10 12. Zaslání WapPush zprávy...........................................................................................10 13. Nejstahovanější obsah.............................................................................................10 14. HiScore...................................................................................................................11 15. Seznam objednávek mobilního čísla..........................................................................12 16. Průběh stahování objednávky...................................................................................12 17. Výměna nekompatibilního obsahu ............................................................................13 18. Skladby...................................................................................................................13 19. Žánry skladeb..........................................................................................................14 20. Interpreti skladeb....................................................................................................14 21. Top skladeb.............................................................................................................15 Zaslání SMS.................................................................................................................16 22. Zaslání SMS............................................................................................................16 Vzhled doručenky emailem......................................................................................17 Formát předání doručenky na HTTP:........................................................................17 23. Zaslání libovolné binární a textové SMS.....................................................................17 ©2004-06 dccimobile.com (dcci s.r.o.)

technical support: Tomáš Rosa [email protected]

2. Volání API a identifikace pro partnerské portály Pokud Vaše aplikace / portál vyžaduje dočasné přihlášení uživatele pro jeho práci, je třeba využít následující způsob volání, který se vyznačuje parametrem SID – Session ID. Po přihlášení je uživateli vygenerován SID, který se následně musí předávat při každém dalším požadavku. Uživatel zůstává přihlášen 10 minut od posledního volání API. Obecné parametry Každý požadavek na API rozhraní obsahuje povinné parametry, které slouží k identifikaci partnera. Tyto parametry jsou: cust hash sid

První čtyři písmena z přihlašovacího jména (pro DCCI login) partnera Přidělený 32 místný identifikátor. Tento identifikátor se nebude měnit. (pozn.: nejedná se o MD5 hesla) Session ID. Není přítomno při prvním požadavku – systém jej vygeneruje a zašle zpět jako součást odpovědi.

Klíč HASH je každému partnerovi přidělen individuelně a není možné jej libovolně vygenerovat mimo server DCCI. Jeho přidělení je možné až na základě registrace na DCCI portálu. Přihlášení se pak provádí příkazem login. Tento způsob identifikace uživatele se vylučuje s následující metodou.

3. Volání API a identifikace pro aplikace Toto volání je zjednodušené a nevyžaduje uchovávání údajů na straně aplikace. Díky tomu je však nutné se při každém požadavku autorizovat. Identifikace partnera Každý požadavek na API rozhraní může obsahovat parametry sloužící k identifikaci partnera. Pokud jsou uvedeny, je využívaná služba přičtená na účet partnera, který pak může získávat smluvní provizi ze služby. Tyto parametry jsou: cust hash

První čtyři písmena z přihlašovacího jména (pro DCCI login) partnera Přidělený 32 místný identifikátor. Tento identifikátor se nebude měnit. (pozn.: nejedná se o MD5 hesla)

Klíč HASH je každému partnerovi přidělen individuelně a není možné jej libovolně vygenerovat mimo server DCCI. Jeho přidělení je možné až na základě registrace na DCCI portálu. Autorizace uživatele v požadavku Pro některé požadavky API (placené a personifikované služby) je nutné se autorizovat systému: login auth

Přihlašovací jméno uživatele Autorizační klíč. Jeho hodnota se spočítá jako MD5 hash následujícíh informací zapsaných za sebou bez mezer: • MD5 hash hesla •

Přihlašovací jméno

©2004-06 dccimobile.com (dcci s.r.o.)


•

Akce

•

Prvních 31 znaků zprávy, pokud je kratší, tak méně.

Tedy: md5(md5(heslo)+login+action+substring(msg,0,31))

4. Formát požadavku Partnerská SMS brána DCCI je umístěna na adrese: http://api.mobilem.cz/xmlapi2.xp

Na toto url se zasílají veškeré požadavky na API. Parametry lze zasílat v GET i POST požadavku. Testovací parametry Tyto testovací parametry použijte pouze pro účely vývoje a ladění vašeho portálu. Bez použití vlastních údajů nemůžete sledovat počty registrovaných uživatelů, počet zaslaných SMS a získávat provizi z využívání služeb. cust hash

tros c4ca4238a0b923820d49b

Příklad zaslání požadavku http://api.mobilem.cz/xmlapi2.xp?cust=tros&hash=c4ca4238&action=listgames &msg=1

5. Formát odpovědí Odpověď na požadavek je zaslána ve formátu XML zprávy. Příklady odpovědí: <mobilem_api status="ok"> <device> 0 pro všechny telefony

Základním tagem je mobilem_api který má povinný parametr status="XX", kde XX je odpověď OK nebo ERROR. status=”ok” V případě odpovědi OK, se další obsah řídí funkcí, která byl požadována. status=”error” Příklad chybové odpovědi: <mobilem_api status="error"> <error> 971 ©2004-06 dccimobile.com (dcci s.r.o.)


<message>Není vybrána kategorie pro výpis

Kódy chyb a jejich popis naleznete v následující tabulce: 901 Chyba při přihlášení uživatele (z bezpečnostních důvodů se nerozlišuje chyba jména, nebo hesla) 902 Nízký kredit 903 Služba není aktivovaná 904 Špatný parametr 905 Text SMS je prázdný 906 Číslo příjemce je špatné 907 Špatný AUTH kód 908 Špatný email 909 Tento účet již existuje, ale ještě nebyl aktivován 910 Tento účet již existuje 911 Tento účet již existuje, ale je zablokován 912 Špatný typ obsahu 913 Tento kód neobsahuje žádná data 970 Uživatel nemá povoleno listování her www.m-game.cz 971 Není vybrána kategorie pro výpis 972 Není vybrán typ pro výpis 995 Pro tuto akci musí být uživatel přihlášen 996 Neznámá akce 997 Chyba při identifikaci partnera 998 Služba není dostupná 999 Služba není dočasně dostupná

©2004-06 dccimobile.com (dcci s.r.o.)


API pro JavaHry, mobilní obsah (loga, melodie, obrázky) Poznámka: Pro používání tohoto API musíte v každém požadavku uvést parametry CUST a HASH a musíte mít povoleno používání tohoto API u DCCI s.r.o. Poznámka: Vzhledem k tomu, že strom kategorií a položky v něm je relativně neměnný údaj, doporučujeme jej ukládat to lokální paměti cache (databáze) a aktualizovat jen cca 1x týdně, nebo po spuštění aplikace.

6. Typy obsahů Typ obsahu se určuje ve vybraných požadavcích na API. Jedná se o parametr „contenttype“. Pokud je možno upřesnit subtyp, pak se jedná o parametr „contentsubtype“. game melodie

tapeta schemata

animace zvuky

Java hry Melodie - rozlišujeme dále na subtypy: • poly • nokiamel • ems • realtone Barevná tapeta Schémata na mobilní telefony. Rozlišujeme dále na subtypy: • schemata101x80 • schemata128x160 • nokia_s60_176x208 • nokia_s40_128x128 • se_300_500_700_1010 Animovaný GIF obrázek Různé zvuky – pískání, chrochtání,...

7. Podporované mobilní telefony (pouze pro hry) Parametry příkazu: action

Hodnota „gamedevices“

Odpověď: 2 Alcatel 715 <shortname /> <maker>Alcatel 0

8. Podporované mobilní telefony k obsahu Parametry příkazu: ©2004-06 dccimobile.com (dcci s.r.o.)


action contenttype

Hodnota „subtypedevices“ Typ obsahu, který chcete zobrazit. Neuvedete-li tento parametr, vylistují se všechny kompatibility

Odpověď: <device name="SonyEricsson K500c"> <scheme type="schemata128x160" /> <scheme type="se_300_500_700_1010" />

API pro službu Mobilem.cz, verze XML 4.9

Recommend Documents