Vývojáři
Adresa: app.smsmanager.com/app/developers
Pro koho je tahle sekce
Pokud zprávy posíláte pouze přes webovou aplikaci, tuhle sekci nemusíte řešit.
Sekce Vývojáři je pro situaci, kdy chcete posílat zprávy automaticky z vlastního systému — z e-shopu, CRM, vlastní aplikace, čehokoli. Místo proklikávání aplikací vás váš systém propojí s SMS Managerem přes API klíč.
Stránka má podtitulek „Připojte svůj systém přes REST API nebo webhooky.".
Typické případy:
- E-shop pošle SMS po objednávce.
- Rezervační systém pošle SMS-připomínku den před schůzkou.
- Banking systém pošle SMS s ověřovacím kódem.
Jak je sekce rozdělená
V levém panelu jsou tři pohledy:
| Pohled | Co tu uděláte |
|---|---|
| API Klíče | Vytvoříte si klíč pro vlastní systém. |
| Webhook / Callback | Naučíte SMS Manager posílat vám zpět informace o stavu zpráv. |
| API Dokumentace | Otevřete kompletní programátorskou dokumentaci. |
V pravém horním rohu je tlačítko Přidat nový API klíč.
Vespod levého panelu je „Stav systému" — drobný indikátor, jestli teď naše služba běží správně. Stavy jednotlivých komponent:
- V provozu (zelený)
- Snížený výkon (žlutý)
- Částečný výpadek (žlutý)
- Velký výpadek (červený)
- Údržba (modrý)
- Neznámý (šedý)
Pod tím tlačítko Více informací vede na status page.
API Klíče
API klíč = jakési „heslo", kterým váš systém prokazuje, že má právo posílat přes vás zprávy. Funguje jen pro vás, je to citlivá věc (kdo ho zná, může posílat na váš účet).
Co tu uvidíte
Karta „API Klíče" s podtitulkem „Vaše API klíče pro přístup k SMSManager API.". V hlavičce tlačítko Načíst existující API klíče s textem „Z bezpečnostních důvodů nenačítáme API klíče automaticky. Pro načtení klikněte na tlačítko 'Načíst existující API klíče'.".
Po načtení uvidíte:
- Hlavní klíč workspace s badgem „main" a poznámkou „Toto je API klíč workspace a nelze ho deaktivovat.".
- Další klíče s maskovanou hodnotou (
abcd*****wxyz) a tlačítkem pro zkopírování.
Když je potřeba ověření: empty state „Vyžadováno ověření účtu" s textem „Pro přístup k API klíčům musíte nejprve ověřit svůj účet." a tlačítkem Ověřit účet.
Jak vytvořit nový klíč
- Klikněte vpravo nahoře na Přidat nový API klíč.
- Otevře se okno „Vytvořit nový API klíč":
- Poznámka (popis klíče).
- Zaškrtávátko „Sdílet kredit z hlavního API klíče" s nápovědou „Pokud není zaškrtnuto, tento API klíč bude mít oddělenou kreditní linii".
- Měna (EUR / CZK / USD).
- Rozsah oprávnění s nápovědou „Určuje, ke kterým API má tento klíč přístup.":
- Plný přístup
- Pouze API (odesílání zpráv)
- Pouze REST API (správa účtu)
- Klikněte na Vytvořit.
Jak upravit existující klíč
- U klíče v seznamu klikněte na ikonu „…".
- Otevře se okno „Upravit API klíč":
- Poznámka
- Výchozí Callback URL
- Zaškrtávátko „Deaktivovat tento API klíč".
- Klikněte na Uložit.
Quickstart — vzorové ukázky
Pod seznamem klíčů jsou přehledné ukázky kódu s nadpisem „Příklad použití API" a podtitulkem „Odeslat zprávu pomocí cURL". Záložky cURL / Node.js / Python / PHP. K dispozici jsou tři ukázky:
- Nejjednodušší odeslání SMS.
- Odeslání SMS s vlastním odesílatelem.
- Odeslání WhatsApp + SMS najednou (popis: „Zprávy přes WhatsApp vyžadují specifikovanou šablonu, která musí být nejprve schválena společností WhatsApp. Pokud příjemce nepoužívá WhatsApp, zpráva bude automaticky odeslána jako SMS.").
Každá ukázka má tlačítko Copy.
Webhook / Callback
Karta „Webhook / Callback" s podtitulkem „Přijímejte aktualizace stavu doručení v reálném čase" a textem „Přidejte parametr callback do požadavku na odeslání zprávy a dostávejte POST notifikace o průběhu doručování...".
Quickstart
Karta „Rychlý start: Odeslání s callbackem" s podtitulkem „POST /v2/message s callback URL". Záložky cURL / Node.js / Python / PHP s ukázkami.
Tlačítko Reference API zpráv vede na detailní dokumentaci.
Příklady payloadů
Karta „Příklady payloadů" s podtitulkem „Příklady JSON odesílaných na vaši callback URL". 4 záložky:
- Odesláno
- Doručeno
- Selhalo
- Příchozí
Tlačítko Dokumentace formátu callbacku vede na detailní popis.
API Dokumentace
Karta s nadpisem „API Dokumentace" a textem „Kompletní reference pro SMSManager API". Popis: „SMSManager API vám umožňuje odesílat SMS, WhatsApp a Viber zprávy programově. Pro autentizaci požadavků použijte váš API klíč.". Tlačítko Zobrazit kompletní dokumentaci.
FAQ
Pod sekcí „Zde naleznete odpovědi na časté otázky týkající se API." najdete 6 otázek:
- „Jak autentizuji API požadavky?"
- „Jaké jsou limity rychlosti?"
- „Jak zpracovávám chyby?"
- „Mohu odesílat hromadné zprávy?"
- „Jak sleduji stav doručení zprávy?"
- „Jaké formáty zpráv jsou podporovány?"
Tipy
- Jeden klíč na jednu aplikaci. Když ho někde uniknete, zablokujete jen tu jednu integraci.
- Pojmenovávejte klíče v Poznámce („e-shop produkce", „testovací cron", „mobilní aplikace v1").
- Webhooky používejte vždy, když to dává smysl.
- Deaktivace místo smazání — pokud klíč nepotřebujete, raději ho deaktivujte.
Bezpečnost
- Klíč nikomu neposílejte. Ani technické podpoře.
- Nedávejte klíč do veřejného Github repozitáře. Když to omylem uděláte, okamžitě ho deaktivujte a vytvořte nový.
- Při podezření na únik klíč okamžitě deaktivujte a vytvořte nový.
- Hlavní (workspace) klíč chráňte zvlášť — nelze ho smazat ani deaktivovat.
Co dělat, když...
…neuvidím tlačítko Přidat nový API klíč (je šedé). Buď ještě nejste ověřený, nebo nemáte oprávnění. Projděte Ověření účtu. Případně se zobrazí okno „Zjištěn problém s relací" — zkuste Obnovit stránku.
…API klíč zkopírovaný před měsícem už nefunguje. Někdo ho mohl deaktivovat. Otevřete seznam, najděte klíč, zkontrolujte status. Nebo si vytvořte nový.
…webhooks mi nechodí.
- Zkontrolujte, že Callback URL je veřejná.
- Vrátí váš endpoint HTTP 2xx odpověď?
- Otevřete Stav systému vlevo — pokud je výpadek, počkejte.
…jsem programátor začátečník. Začněte s cURL ukázkou z Quickstart sekce.