Přeskočit na hlavní obsah

API SmsManager

JSON API (CLOUD API)

JSON API je moderní způsob odesílání zpráv, který nahrazuje starší REST API (HTTP API a XML API). Jedná se o samostatné prostředí v rámci AWS Cloud, které se vyznačuje vysokou propustností a dostupností.

Implementace je velmi snadná a je možné využít již existující knihovny pro různé programovací jazyky. Řadu z nich přímo spravujeme nebo lze využít také knihovny od třetích stran.

note

JSON API je automaticky dostupné pro nově registrované účty (po 20. 1. 2025). Starší účty, které mají API klíč vygenerován pro http-api nebo xml-api jsou migrovány na nový systém postupně a automaticky. Zpřístupnit JSON API můžeme také na vyžádání.

Všechny existující verze API

VerzeID zprávyPodporovánoDoporučené
Verze http-api nebo xml-apiintAnoNe
JSON APIuuidAnoAno

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:

  1. Změna domény API na https://api.smsmngr.com/
  2. Úprava adresy endpointu na /v2/simple/message (původní názvy parametrů mohou být použity i v nové verzi)
  3. 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 parametru apikey (pro GET metodu).
  4. 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.