Jak používat Postman k testování API Ozeki SMS Gateway

Tento návod ukazuje, jak používat Postman k testování různých HTTP/JSON/REST API volání nabízených Ozeki SMS Gateway. Podle kroků v této příručce si stáhnete nástroj pro testování API Postman, vytvoříte ukázkové API požadavky a odešlete testovací SMS pomocí Postmanu. Uvidíte také odpověď vrácenou Ozeki SMS Gateway na API požadavek.

Co je SMS Gateway?

SMS Gateway je služba, která umožňuje počítačům odesílat a přijímat SMS (Short Message Service) zprávy do a ze zařízení s podporou SMS přes telekomunikační síť. SMS Gateway může usnadnit komunikaci mezi aplikacemi a mobilními sítěmi, umožňovat automatizované, hromadné a často obousměrné zasílání zpráv.

Co je API?

API neboli Application Programming Interface je soubor pravidel a protokolů pro vytváření a interakci se softwarovými aplikacemi. API umožňují různým softwarovým systémům komunikovat mezi sebou, což vývojářům umožňuje používat předdefinované funkce a procedury pro interakci se systémem, aplikací nebo službou.

Jak používat Postman k testování API Ozeki SMS Gateway (Rychlé kroky)

Jak používat Postman k testování API Ozeki SMS Gateway

  1. Nainstalujte Ozeki SMS Gateway
  2. Stáhněte si platformu Postman API
  3. Otevřete Ozeki SMS Gateway
  4. Nainstalujte HTTP uživatele v Ozeki SMS Gateway
  5. Spusťte Postman
  6. Vytvořte účet v Postmanu
  7. Přidejte nový požadavek v Postmanu
  8. Zadejte URL požadavku
  9. Klikněte na odeslat
  10. Zobrazte přijatou odpověď v Postmanu
  11. Zkontrolujte záložku událostí v Ozeki SMS Gateway, abyste viděli přijatý požadavek
  12. Zobrazte zprávu ve složce 'Odeslané' v Ozeki SMS Gateway

Krok 1 - Vytvořte HTTP API uživatele v Ozeki SMS Gateway

Jak vytvořit HTTP API uživatele (Video návod)

Toto krátké, snadno pochopitelné video v délce 25 sekund vám podrobně ukáže, jak vytvořit HTTP API uživatele v Ozeki SMS Gateway. Video začíná s již otevřeným Ozeki SMS Gateway. Dokončením kroků ve videu vytvoříte HTTP uživatele. Toto video vám také dá náhled na to, jak snadné je nastavit Ozeki SMS Gateway, a uvidíte, že nabízí velmi výkonný dashboard, který vám umožní přístup k nejdůležitějším funkcím jedním kliknutím.

Video 1 - Jak vytvořit HTTP API uživatele

Jak přidat uživatele/aplikaci

Na domovské stránce Ozeki přejděte na panel 'Uživatelé a aplikace' umístěný na pravé straně obrazovky. Klikněte na 'Přidat nového uživatele/aplikaci', zvýrazněno červenou šipkou na obrázku (Obrázek 1). Tato akce otevře menu, kde můžete zadat potřebné údaje pro vytvoření nového uživatele nebo aplikace. Přidání HTTP uživatele je klíčové pro testování API Ozeki SMS Gateway.

Přidat uživatele/aplikaci
Obrázek 1 - Přidat uživatele/aplikaci

Jak nainstalovat HTTP uživatele

Uvidíte seznam typů uživatelů, vyhledejte položku 'HTTP uživatel' v seznamu instalace síťových uživatelů. Klikněte na odkaz Instalovat vedle položky instalace HTTP uživatele (Obrázek 2). Tím spustíte proces instalace účtu HTTP uživatele, což vám umožní odesílat zprávy do vašeho systému pomocí HTTP GET a HTTP POST požadavků.

Nainstalovat HTTP uživatele
Obrázek 2 - Nainstalovat HTTP uživatele

Nastavte uživatelské jméno a heslo

Dále v záložce 'Obecné' zadejte požadované uživatelské jméno a heslo pro nového HTTP uživatele (Obrázek 3). Po potvrzení, že uživatelské jméno a heslo jsou správné, klikněte na tlačítko 'Ok', abyste pokračovali ve vytváření uživatelského účtu. Tato akce dokončí nastavení a nainstaluje nového HTTP uživatele do systému.

Zadat uživatelské jméno a heslo
Obrázek 3 - Zadat uživatelské jméno a heslo

Zkontrolujte vytvořeného HTTP API uživatele

Jakmile vytvoříte HTTP uživatele, budete přesměrováni na stránku s detaily uživatele, kde můžete zobrazit různé informace o uživateli, jak je vidět na Obrázku 4. Můžete například zkontrolovat Události, testovat s HTTP Post požadavky, změnit uživatelské jméno a heslo, číst dokumentaci a zobrazovat příchozí a odchozí SMS zprávy.

HTTP API uživatel vytvořen
Obrázek 4 - HTTP API uživatel vytvořen

Krok 2 - Stáhněte a nainstalujte Postman

URL ke stažení:

https://www.postman.com/downloads/

Jak nainstalovat Postman a vytvořit účet (Video návod)

V následujícím video návodu vám představíme kroky, které je třeba provést k instalaci platformy Postman API, vytvoření bezplatného účtu a navigaci v hlavním dashboardu. Poskytujeme podrobný návod, takže nezpůsobí žádné problémy. Video začíná přístupem na web Postman a provede vás procesem registrace, aby jste měli na konci plně funkční nastavení Postmanu. Toto video vám dá náhled na to, jak uživatelsky přívětivá je platforma Postman API, demonstruje její přímočarou instalaci a nastavení účtu.

Video 2 - Jak nainstalovat Postman a vytvořit účet

Jak stáhnout instalační soubor Postmanu

Chcete-li začít s instalací softwaru Postman, otevřete svůj webový prohlížeč a do adresního řádku zadejte odkaz ke stažení. Po načtení stránky přejděte dolů a na levé straně najděte instalační program pro Windows 64-bit. Kliknutím na odkaz spustíte stažení instalačního souboru, jak je znázorněno na obrázku 5.

Stažení instalačního souboru Postmanu
Obrázek 5 - Stažení instalačního souboru Postmanu

Jak otevřít instalační soubor

Po dokončení stahování najděte sekci stahování ve svém prohlížeči (obvykle malá šipka směřující dolů v pravém horním rohu), kde najdete instalační soubor Postmanu. Klikněte na tlačítko 'Otevřít soubor', abyste spustili instalaci platformy Postman API.

Otevření instalačního souboru
Obrázek 6 - Otevření instalačního souboru

Instalace Postmanu

Proces instalace je po otevření instalačního souboru plně automatizovaný, stačí počkat, až se dokončí (obrázek 7). Po dokončení instalace budete muset zaregistrovat účet Postman, pokud jej ještě nemáte. Postman nabízí uživatelsky přívětivé rozhraní a výkonné funkce, které usnadňují odesílání a přijímání HTTP požadavků, které se používají k ověření funkčnosti vašeho nastavení SMS brány.

Instalace Postmanu
Obrázek 7 - Instalace Postmanu

Jak vytvořit účet Postman

Pokud ještě nemáte účet, Postman vás vyzve k vytvoření bezplatného účtu. Chcete-li vytvořit účet, zadejte svou pracovní e-mailovou adresu do pole na pravé straně a klikněte na tlačítko 'Vytvořit bezplatný účet' (obrázek 8). Tato akce vás přesměruje do webového prohlížeče, kde můžete dokončit registraci. Účet Postman je nezbytný pro přístup k plné škále funkcí a efektivní testování vašich API, včetně Ozeki SMS brány.

Vytvoření účtu Postman
Obrázek 8 - Vytvoření účtu Postman

Zadejte uživatelské jméno a heslo Postman

Po otevření okna prohlížeče uvidíte pole pro 'Uživatelské jméno' a 'Heslo'. Nastavte uživatelské jméno a silné heslo pro svůj účet. Do těchto polí zadejte zapamatovatelné, ale bezpečné údaje. Po vyplnění těchto údajů klikněte na tlačítko 'Vytvořit bezplatný účet', abyste dokončili registraci (obrázek 9).

Zadejte uživatelské jméno a heslo Postman
Obrázek 9 - Zadejte uživatelské jméno a heslo Postman

Zadejte své jméno a roli

V dalším kroku budete přesměrováni na jinou stránku, která vás vyzve k zadání vašeho jména a pracovní role. Do textového pole 'Vaše jméno' zadejte své jméno a z rozevírací nabídky pod 'Jaká je vaše role?' vyberte svou roli (obrázek 10). Po zadání těchto informací najděte a klikněte na tlačítko 'Pokračovat'. Tento krok pomáhá Postmanu přizpůsobit prostředí vašim potřebám a preferencím, což zlepšuje váš pracovní postup při testování API.

Zadejte své jméno a roli
Obrázek 10 - Zadejte své jméno a roli

Postman byl spuštěn

Pokud jste správně postupovali podle předchozích kroků, Postman se nakonec spustí. Hlavní panel, jak je znázorněno na obrázku 11, vás přivítá. Odtud můžete přistupovat ke svému osobnímu pracovnímu prostoru a začít testovat své API. Tato hlavní stránka slouží jako centrální rozbočovač pro všechny vaše potřeby vývoje a testování API, což vám umožňuje efektivně spravovat vaše požadavky, prostředí a další.

Postman byl spuštěn
Obrázek 11 - Postman byl spuštěn

Krok 3 - Odeslání HTTP GET požadavku pomocí Postmanu pro odeslání SMS

Jak odeslat HTTP GET požadavek pomocí Postmanu pro testování Ozeki SMS Gateway API (Video návod)

Toto krátké 39sekundové video ukazuje, jak odeslat HTTP GET požadavek pomocí Postmanu pro testování Ozeki SMS Gateway API. Od hlavního panelu Postmanu se naučíte, jak přidat nový požadavek a odeslat jej vašemu HTTP uživateli vytvořenému v Ozeki SMS Gateway. Také zjistíte, jak zkontrolovat přijatou zprávu v Ozeki SMS Gateway a zobrazit podrobnosti zprávy. Toto rychlé a jasné video vám zajistí, že můžete efektivně testovat své API požadavky s lehkostí.

Video 3 - Jak odeslat HTTP GET požadavek pomocí Postmanu pro testování Ozeki SMS Gateway API

Jak přidat nový požadavek

Chcete-li vytvořit nový požadavek, jednoduše klikněte na tlačítko '+', jak je znázorněno na obrázku 12. Tím zahájíte proces vytváření nového API požadavku v Postmanu. Odtud budete moci konfigurovat podrobnosti požadavku, jako je HTTP metoda, URL, hlavičky a tělo, abyste mohli efektivně testovat své Ozeki SMS Gateway API.

Přidání nového požadavku
Obrázek 12 - Přidání nového požadavku

Vložit URL požadavku

Pro provedení testu použijeme HTTP GET požadavek. Začněte nalezením textového pole pro URL v rozhraní Postman, jak je znázorněno na obrázku 13. Do tohoto textového pole vložte URL vašeho požadavku. Příklad požadavku najdete v části 'Krok 4 - Příklad požadavku', pokud sjedete dolů. Nezapomeňte nahradit uživatelské jméno a heslo v požadavku uživatelským jménem a heslem, které jste nastavili při vytváření HTTP uživatele.

Vložit URL požadavku
Obrázek 13 - Vložit URL požadavku

Jak odeslat požadavek

Jakmile byly předchozí kroky provedeny správně, klikněte na modré tlačítko Odeslat umístěné v pravém horním rohu rozhraní Postman. (Obrázek 14) Tato akce odešle váš HTTP GET požadavek do Ozeki SMS Gateway, což vám umožní otestovat funkčnost API a ověřit, že vaše nastavení funguje podle očekávání.

Odeslat požadavek
Obrázek 14 - Odeslat požadavek

Zkontrolujte přijatou odpověď

Pokud byl HTTP GET požadavek úspěšný, obdržíte odpověď, kterou lze zobrazit v dolní části rozhraní Postman. Úspěch požadavku je indikován stavovým kódem 0 a stavovou zprávou s textem 'Zpráva přijata k doručení.' (Obrázek 15) Toto potvrzení znamená, že zpráva byla skutečně odeslána přes Ozeki SMS Gateway.

Přijatá odpověď
Obrázek 15 - Přijatá odpověď

Zkontrolujte přijatý požadavek v Ozeki SMS Gateway

Pro ověření úspěšného HTTP GET požadavku v Ozeki SMS Gateway přejděte na kartu 'Události', jak je znázorněno na obrázku 16. Zde byste měli vidět položku s názvem 'Odeslání přijato', která potvrzuje, že požadavek byl úspěšný. Tento krok zajišťuje, že zpráva byla nejen odeslána, ale také správně přijata a zpracována SMS Gateway.

Požadavek přijat v Ozeki SMS Gateway
Obrázek 16 - Požadavek přijat v Ozeki SMS Gateway

Zkontrolujte odeslanou zprávu

Pro zobrazení odeslané zprávy v Ozeki SMS Gateway sjeďte dolů na levé straně až k sekci ovládací tabulky 'Složky'. Klikněte na složku 'Odeslané', jak je uvedeno na obrázku 17. Tato akce otevře menu, kde můžete vidět seznam odeslaných zpráv. Zde najdete testovací zprávu API.

Zpráva odeslána
Obrázek 17 - Zpráva odeslána

Krok 4 - Příklad požadavku

Příklad požadavku

https://127.0.0.1:9508/api?command=SendMessage&Username=ht1&Password=qwe123& Recipient=06203105366&MessageType=SMS:TEXT&MessageData=Hello+World&responseformat=json

Příklad odpovědi

{
	"response": {
		"action": "sendmessage",
		"data": {
			"acceptreport": {
				"statuscode": 0,
				"statusmessage": "Message accepted for delivery",
				"messageid": "a79af012-741b-4272-ba59-427524f2e546",
				"recipient": "06203105366",
				"messagetype": "SMS:TEXT",
				"messagedata": "Hello World"
			}
		}
	}
}

Často kladené otázky

Jaké jsou některé běžné testovací scénáře pro testování SMS Gateway API?

Při testování SMS Gateway API je důležité pokrýt řadu běžných testovacích scénářů, aby bylo zajištěno spolehlivé fungování a výkon systému. Tyto testovací scénáře obvykle zahrnují ověření úspěšného doručení zpráv, testování různých formátů zpráv, jako je prostý text, multimédia a Unicode, a kontrolu případných zpoždění v doručení zpráv. Dále je klíčové otestovat, jak systém zvládá limity délky zpráv a ověřit, jak dobře API zvládá scénáře chybového zpracování. Tyto komplexní testy pomáhají zajistit, že SMS Gateway funguje efektivně za různých podmínek a zvládá různé požadavky na zasílání zpráv.

Na jaké klíčové aspekty je třeba se zaměřit při testování SMS Gateway API?

Při testování SMS Gateway API je nezbytné zaměřit se na různé kritické faktory, aby bylo zajištěno optimální fungování. Mezi klíčové aspekty patří rychlost doručení zpráv, přesnost formátování zpráv, jako je kódování znaků a zpracování speciálních znaků, a efektivita mechanismů pro zpracování chyb. Dále je důležité vyhodnotit dobu odezvy API, abyste pochopili, jak rychle systém reaguje na požadavky. Testování škálovatelnosti a spolehlivosti je také důležité, aby bylo zajištěno, že brána zvládne velký objem zpráv efektivně bez ohrožení výkonu nebo stability.

Jaké jsou některé běžné výzvy při testování SMS Gateway API?

Během testování SMS Gateway API se mohou objevit různé běžné výzvy, které je třeba řešit, aby bylo zajištěno robustní fungování. Problémy s připojením k síti mohou výrazně ovlivnit doručení zpráv, proto je klíčové testovat v různých síťových podmínkách. Dále je důležité zajistit kompatibilitu s různými mobilními operátory, aby bylo zaručeno, že zprávy budou doručeny napříč různými sítěmi. Efektivní zpracování selhání doručení zpráv a implementace vhodných bezpečnostních opatření k ochraně uživatelských dat během přenosu jsou také kritické aspekty, které vyžadují pečlivé zvážení pro zachování integrity dat a důvěry uživatelů.

Je Postman zcela zdarma?

Postman nabízí jak bezplatnou, tak placenou verzi. Bezplatná verze poskytuje základní funkce, jako je návrh, testování a ladění API. Podporuje jednotlivé vývojáře a malé týmy s jednoduchými nástroji pro spolupráci. Pro pokročilé funkce, jako je týmová spolupráce, monitorování API a automatizované testování, však může být nutné přejít na placené plány Postman, které nabízejí další funkce a podporu.

Abychom to shrnuli

Udělali jsme maximum, abychom to udělali co nejjednodušší a provedli vás všemi detaily co nejpříjemněji. Podle výše uvedených instrukcí můžete řešení rychle vytvořit. Nyní můžete otestovat Ozeki SMS Gateway API. Viděli jste výhody, které Ozeki SMS Gateway přináší. Pokud byste chtěli objevit více užitečných informací o výhodách dalších podobných řešení, navštivte prosím ozeki-sms-gateway.com.

More information