API login

While the data of the agenda lists are freely available, you must log in first to access the rest of the API.

If you do not have login credentials, contact us.

The system supports two login methods:

HTTP BASIC login
Sessionid login

HTTP BASIC login

To log in, you can use the standard HTTP BASIC Authentication header, which must be sent with every request.
Please keep in mind that here you send your login credentials in "readable" form, so we recommend using HTTPS access. Conversely, if HTTPS access is not available to you, for security reasons we recommend access using sessionid.

Sessionid login

Mainly for READ clients, where HTTP BASIC login cannot be used everywhere, authentication using sessionid is available.
For compatibility, several (equivalent) methods can be used; the login has two phases.

1. Obtaining the sessionid
To the address:

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

send the following PUT or POST request.

XML format:

<tipmoto>
  <login>YOUR-LOGIN</login>
</tipmoto>

JSON format:

{"tipmoto":{"login":"YOUR-LOGIN"}}

Alternatively, you can send a GET request:

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

The system returns a response in the requested format.
XML format:

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

JSON format:

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

HTML format (\t = tab character):

56c00b9ccf74116b1bbf49431cd400276c21b54874be3565ca13b335c8a16588\t9b27cbf4a299b8704499423710ba2c8c90effb8341985aae18bd6c0b79d9389d

2. The login itself
Using the obtained sessionid, hashkey and your password, you then log in:

To the address:

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

send the following PUT or POST request.

XML format:

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

JSON format:

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

Alternatively, you can send a GET request:

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

Where the value PASSWORDHASH is calculated as:

sha512(YOUR-LOGIN + sha512(PASSWORD) + HASHKEY)

where:

sha512 = the SHA512 hash function
+ = concatenation
YOUR-LOGIN = the login assigned to you
PASSWORD = the password assigned to you
HASHKEY = the hashkey obtained in the previous step

3. Working with the sessionid
Then add the URL parameter ?sessionid=SESSIONID to all requests, where you obtained the value SESSIONID in the first step.

The sessionid is valid for 10 min. from the last request and requires access from the same IP address. It can be tested, in the same way as in the previous steps, by sending the parameter SESSIONID to:

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

When working with sessionid login, you do not need to parse the text error messages; you can use the returned HTTP codes.