Intro
JSON API (označováno také jako CLOUD API) je nový způsob odesílání zpráv, který nahrazuje starší API (HTTP API a XML API). Jedná se o plnohodnotnou alternativu, která nabízí některé funkce, které v původních API nejsou dostupné.
- Definování flow zprávy (odesílání přes více kanálů - SMS, Viber, WhatsApp, Facebook Messenger)
- Definice callback URL pro každou zprávu zvlášť
- Předávání vlastního objektu (payload), který se přeposílá zpět ve všech callback volání
- Propustnost až 1000 zpráv za sekundu
- Architektura postavena na zpracování zpráv v AWS Cloud, která zaručuje vysokou dostupnost a minimální latenci
Přechod na JSON API z původního API
Pokud používáte starší verze API, doporučujeme přechod na JSON API. Jedná se o nové API, které je vytvořeno s ohledem na moderní standardy.
JSON API je verze API, která dovoluje největší míru flexibility a nových funkcí. Zároveň nabízí i zjednodušené metody GET/POST pro jednoduchou integraci do systémů třetích stran.
Všechny existující verze API
| Verze | ID zprávy | Podporováno | Doporučené |
|---|---|---|---|
Verze http-api nebo xml-api | int | Ano | Ne |
| JSON API | uuid | Ano | Ano |
Rychlost API http-api a xml-api
Původní verze API http-api a xml-api jsou a budou stále podporovány. Nicméně využívají jiný systém autorizace a odezva je tak pomalejší (nejčastěji okolo 1s) než v případě použití JSON API.
Tyto původní verze API mají nastavenou sdílenou omezenou propustnost. Krátkodobě tedy může dojít k situaci, že API bude odpovídat stavem 429 Too Many Requests. V takovém případě opakujte požadavek později.
Doporučujeme využít JSON API nebo zjednodušené endpointy /simple/message, které mají nastavenou řádově vyšší sdílenou propustnost.
Rozdíly mezi http-api a JSON API
Pokud používáte původní verzi http-api, můžete přejít na JSON API a odpovídající GET/POST metody. Kompletní přechod vyžaduje pouze čtyři jednoduché kroky:
- Změna domény API na
https://api.smsmngr.com/ - Úprava adresy endpointu na
/v2/simple/message(původní názvy parametrů mohou být použity i v nové verzi) - API klíč je zachovaný. Je potřeba jen změnit jeho umístění. Nyní je potřeba jej umístit do HTTP hlavičky s názvem
x-api-key(pro POST metodu) nebo v URL query parametruapikey(pro GET metodu). - Ověřte, že správně zpracováváte odpověď API: Dříve byla odpověď v textovém formátu. Nyní se používá JSON. Pro identifikaci (ID zprávy) se dříve používalo celé číslo (int), nyní se jedná řetězec (string UUID).
SSL
Pouze původní verze xml-api a http-api byly dostupné i přes HTTP (tedy bez SSL). Nicméně toto již z bezpečnostních důvodů není možné. Všechny API služby jsou dostupné pouze přes HTTPS.
Pro speciální případy, kdy je potřeba použít HTTP, nás prosím kontaktujte.