Supported HTTP methods

HTTP vs HTTPS

The API supports access via both HTTP and HTTPS.
We recommend accessing via HTTPS; HTTP is kept only for backward compatibility for clients who lack the technical means for machine access over HTTPS.

API HTTP methods vs standard REST API

Compared to a standard REST API there are minor differences, explained in the article differences from the usual REST API

Reading a record

Data can be read using the GET method. The output format is taken into account.

Deleting a record

A record can be deleted using the DELETE method sent to the detail URL (i.e. one containing the identifier).
Alternatively, a record can be deleted using the PUT or POST methods with the attribute action="delete" sent (in the structure of the given agenda, i.e. e.g. <moto>), i.e. e.g. <moto action="delete">

If the record does not exist, code 404 is returned. If the record was deleted successfully, code 200 is returned.

Creating/updating a record

The API does not distinguish the meaning of the PUT and POST methods, as is customary in REST APIs. The meaning always depends on the target URL and on the content sent.
When records are sent, they are either added or updated depending on whether the identifier was found.
A record sent to the detail URL always performs an update.

Format of PUT and POST requests

PUT request expects the data sent directly in the request body
POST request expects the content sent as form data (multipart/form-data), with the data in the form field named tipmoto.
This difference exists for compatibility with some older client applications.

Identifier of a new record

The identifier of the created record is passed in several ways.

In the HTTP header Location: https://api.tipmoto.com/c/12345/moto/123456789.xml (can be suppressed with the option ?no-http-location=true - for more see parameters in the URL)

As part of the response (example in XML format):

<tipmoto>
  <success>true</success>
  <result>
    <id>123456789</id>
  </result>
</tipmoto>