api.tipmoto.com » Dokumentace API » Referenční » Přihlášení k API

Přihlášení k API

Zatímco data agendy lists jsou k dispozici volně, pro přístup ke zbylé části API je nutné se nejprve přihlásit!

Nemáte-li přístupové údaje, kontaktujte nás.

Systém podporuje dvě metody přihlášení:

• HTTP BASIC přihlášení
• Sessionid přihlášení

HTTP BASIC přihlášení

Pro přihlášení lze použít klasickou HTTP BASIC Authentication hlavičku, kterou je třeba zasílat v každém požadavku.
Mějte prosím na paměti, že zde zasíláte přihlašovací údaje v "čitelné" podobě, proto doporučujeme využít HTTPS přístup! Naopak nemáte-li k dispozici HTTPS přístup, vzhledem k bezpečnosti doporučujeme přístup pomocí sessionid.

Sessionid přihlášení

Především pro READ klienty, kdy ne všude je možné využít HTTP BASIC přihlášení, je k dispozici autentizace pomocí sessionid.
Kvůli kompatibilitě je možné použít více metod (které jsou rovnocenné), přihlášení je dvoufázové.

1. Získání sessionid
Na adresu:

http(s)://api.tipmoto.com/gethash.{format}

zašlete následující PUT nebo POST požadavek.

XML formát:

<tipmoto>
  <login>VASLOGIN</login>
</tipmoto>

JSON formát:

{"tipmoto":{"login":"VASLOGIN"}}

Případně je možné zaslat GET požadavek:

http(s)://api.tipmoto.com/gethash.{format}?login=VASLOGIN

Ze systému obdržíte odpověď dle požadovaného formátu.
Formát XML:

<tipmoto>
  <sessionid>56c00b9ccf74116b1bbf49431cd400276c21b54874be3565ca13b335c8a16588</sessionid>
  <hashkey>9b27cbf4a299b8704499423710ba2c8c90effb8341985aae18bd6c0b79d9389d</hashkey>
</tipmoto>

Formát JSON:

{"tipmoto":{"sessionid":"56c00b9ccf74116b1bbf49431cd400276c21b54874be3565ca13b335c8a16588","hashkey":"9b27cbf4a299b8704499423710ba2c8c90effb8341985aae18bd6c0b79d9389d"}}

Formát HTML (\t = tabulátor):

56c00b9ccf74116b1bbf49431cd400276c21b54874be3565ca13b335c8a16588\t9b27cbf4a299b8704499423710ba2c8c90effb8341985aae18bd6c0b79d9389d

2. Samotné přihlášení
Pomocí získaných sessionid, hashkey a vašeho hesla se následně přihlásíte:

Na adresu:

http(s)://api.tipmoto.com/login.{format}

zašlete následující PUT nebo POST požadavek.

XML formát:

<tipmoto>
  <sessionid>SESSIONID</sessionid>
  <password>PASSWORDHASH</password>
</tipmoto>

JSON formát:

{"tipmoto":{"sessionid":"SESSIONID","password":"PASSWORDHASH"}}

Případně je možné zaslat GET požadavek:

http(s)://api.tipmoto.com/login.{format}?sessionid=SESSIONID&password=PASSWORDHASH

Kde se hodnota PASSWORDHASH vypočítá jako:

sha512(VASLOGIN + sha512(PASSWORD) + HASHKEY) 

kde:

• sha512 = hashovací funkce SHA512
• + = funkce zřetězení
• VASLOGIN = Vám přidělený login
• PASSWORD = Vám přidělené heslo
• HASHKEY = hashkey získaný v předchozím kroku

3. Práce se sessionid
Následně do všech požadavků přidávejte URL parametr ?sessionid=SESSIONID, kde jste hodnotu SESSIONID získali v prvním kroku.

Platnost sessionid je 10min. od posledního požadavku a vyžaduje přístup ze stejné IP adresy. Lze otestovat analogicky jako v předchozích krocích zasláním parametru SESSIONID na:

http(s)://api.tipmoto.com/testsessionid.{format}

Při práci s přihlašování dle sessionid není nutné parsovat textové chybové hlášky, ale lze používat vracené HTTP kódy.

Kontaktujte nás