Verzování Mergado API

Poradna Obecná diskuse o MERGADU
1

Dobrý den,

dostala se ke mně informace, že MERGADO plánuje vypnout v1 API a chci tedy ověřit, jakou verzi API používáme. V souvislosti s tím bych měl dvě otázky:

  1. Zkoušel jsem dotaz na verzi API a nehledě na to, jakou verzovací hlavičku jsem použil (a i když jsem nepoužil žádnou), dostal jsem vždy odpověď v2. Pochopil jsem to tak, že dotaz na verzi API vrací verzi, kterou kontaktuji, je to tak, nebo jsem dotaz špatně pochopil a výsledkem je vždy poslední verze API?

  2. Pro kontaktování API používáme mergado API client. Chtěl jsem se zeptat, jakou verzi API tento balíček používá?

Děkuji.

2 Likes
2

Dobrý den,

Pochopil jsem to tak, že dotaz na verzi API vrací verzi, kterou kontaktuji, je to tak, nebo jsem dotaz špatně pochopil a výsledkem je vždy poslední verze API?

V tuto chvíli tento endpoint vrací vždy aktuální, tedy poslední vydanou, verzi API. Chápu, že popis v dokumentaci může být matoucí. V nejbližší době ho proto upravíme. :slight_smile:

Chtěl jsem se zeptat, jakou verzi API tento balíček používá?

Tato knihovna verzování vůbec neřeší. Používá tedy defaultní verzi API, které v tuto chvíli odpovídá verzi v1.

Každopádně je dobré připomenout, že přechod na verzi v2 ovlivní pouze tyto API endpointy:

V případě, že tyto endpointy vůbec nepoužíváte nebo z nich používáte data v podobě, v jaké jsou nyní uvedeny v dokumentaci, Vás přechod na verzi v2 vůbec neovlivní.

4 Likes
3

Děkuji za radu, ovlivněné endpointy nepoužíváme, takže budeme v pořádku :+1:

API dokumentace je podle mě na dobré úrovni, jen jsem si nebyl jistý tímto endpointem. Určitě by mi dávalo smysl mít oba endpointy, jednak pro zjištění nejnovější verze a jednak pro zjištění verze, kterou kontaktuji.

Měl bych ještě poslední otázku, když knihovna vůbec verzování neřeší, měli bychom jej nějakým způsobem explicitně specifikovat? Knihovnu jsem zkoumal a nenašel jsem způsob, jak bych mohl verzovací hlavičku poslat bez úpravy knihovny samotné.

Konkrétně používáme fluent zápis, například:
$client->shops->$shopId->get();

3 Likes
4

Specifikaci verze v tuto chvíli není potřeba zavádět. Po odstranění v1 bude totiž fungování API jednotné a plnohodnotně si proto vystačíte s defaultní verzí.

Možnost verzování sice zachováme, do budoucna ale nemáme v plánu fungování stávající verze jakkoli měnit. Pokud to přece jen někdy bude potřeba, možnost specifikovat verzi do knihovny přidáme a budeme Vás o případných změnách s dostatečným předstihem informovat.

5 Likes