api.tipmoto.com » Dokumentace API » Referenční » Podporované HTTP operace

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.

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é 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, který modifikuji pomocí detailového URL, musí vždy existovat.

POZOR - existuje ovšem rozdíl mezi formáty operacemi PUT a POST!
V případě POST se očekává obsah zaslaný jako formulářova data (multipart/form-data) a to ve formulářovém poli s názvem tipmoto. Tento rozdíl je zde kvůli funkčnosti na některých klientských aplikacích.

Volba formátu při vytváření záznamu

Formát, v jakém jsou očekávána data a v jakém je odpověď, jsou vždy shodné a nelze je kombinovat.

Identifikátor nového záznamu

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

TipMoto.com Kontaktujte nás