Podporované HTTP operace

HTTP vs HTTPS

API podporuje přístup přes HTTP i HTTPS.
Doporučujeme přistupovat přes HTTPS, HTTP je pouze zpětně kompatibilní pro klienty, kteří nemají technické zázemí pro strojový přístup k HTTPS.

HTTP operace API vs standardní REST API

Oproti standardnímu REST API máme drobné odlišnosti, vysvětlení ve článku odlišnosti od obvyklého REST-API

Přečtení záznamu

Data lze přečíst pomocí metody GET. Je zohledňován výstupní formát.

Mazání záznamu

Záznam lze mazat pomocí metody DELETE zaslané na detailové URL (tj. obsahující identifikátor).
Alternativně lze záznam smazat pomocí operací PUT nebo POST se zaslaným atributem action="delete" (ve struktuře dané agendy, tj. např. <moto>), tedy např. <moto action="delete">

Pokud záznam neexistuje, je vrácen kód 404. Pokud se záznam podařilo smazat, je vrácen kód 200.

Vytvoření/aktualizace záznamu

API nerozlišuje význam mezi operacemi PUT a POST, jak bývá v REST-API zvykem. Význam vždy závisí na cílové URL a na obsahu, který je zaslán.
Pokud zasíláme záznamy, jsou záznamy buď přidány nebo aktualizovány podle toho, zda byl nalezen identifikátor.
Záznam zasílaný na detailové URL provádí vždy operaci editace.

Formát PUT a POST požadavku

PUT požadavek očekává data zaslaná přímo v těle požadavku
POST požadavek očekává obsah zaslaný jako formulářova data (multipart/form-data), kde data jsou ve formulářovém poli s názvem tipmoto.
Tento rozdíl je zde kvůli funkčnosti na některých starších klientských aplikacích.

Identifikátor nového záznamu

Identifikátor vytvořeného dokladu je předán několika způsoby.

HTTP Hlavičkou Location: https://api.tipmoto.com/c/12345/moto/123456789.xml (lze potlačit volbou ?no-http-location=true - více viz. parametry v URL

Součást odpovědi (příklad ve formátu XML):

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