Vaše první žádost rozhraní API v aplikaci Zkratky na iPhonu nebo iPadu
Chcete‑li si vyžádat své první API, vytvořte URL odkazující na „koncový bod“ API, s nímž chcete komunikovat, a pak toto URL předejte do akce Načíst obsah URL. Po spuštění zkratky tato akce vytvoří požadavek API.
Vytvoření požadavku API
Koncový bod Typicode vyžaduje požadavek URL v tomto formátu:
https://jsonplaceholder.typicode.com/[RESOURCE]
Text v závorce je zdroj, ke kterému chcete získat přístup. Typicode poskytuje celou řadu příkladů testování požadavků. V tomto příkladu se použije https://jsonplaceholder.typicode.com/users pro vyžádání seznamu uživatelů.
V aplikaci Zkratky
na iOS nebo iPadOS zařízení přidejte požadavek k URL.Požadavek
usersvrátí seznam uživatelů.Hledání můžete upřesnit zadáním ID konkrétního uživatele:
https://jsonplaceholder.typicode.com/users/6. Tento požadavek vrátí uživatele, jehož ID je 6.Mnohá rozhraní API povolují požadavkům používání následujícího formátu:
https://jsonplaceholder.typicode.com/users?username=Bret. Interpunkční znaménko „?“ je na začátku požadavku, který vyhledává položky používající páry klíč/hodnota. V tomto příkladu požadavek?username=Brethledá uživatele, jehož uživatelské jméno je Bret.Podporovaná hledání a požadavky najdete v dokumentaci k vašemu rozhraní API.
Provedení požadavku API s akcí Načíst obsah URL
V aplikaci Zkratky
na iOS nebo iPadOS zařízení klepněte v akci „Načíst obsah URL“ na Zobrazit více.Pro typy požadavků API, které lze zadat, budou zpřístupněny následující volby:
GETumožňuje načíst data.POSTumožňuje vytvořit nová data.PUTumožňuje aktualizovat existující data přepsáním.PATCHumožňuje existující data změnit.DELETEumožňuje odstranit objekt specifikovaný v URL požadavku.
V tomto příkladu načtěte data z rozhraní API od Typicode pomocí požadavku
GET.Nyní, když akce URL obsahuje váš požadavek a akce Načíst obsah URL je nastavena na
GETdata, jste připraveni na vytvoření požadavku API.Poznámka: Když je akce Načíst obsah URL přepnuta na
POST,PUTneboPATCH, bude přidán nový parametr s názvem Tělo požadavku. Akce Tělo požadavku umožňuje odeslat do API jako součást vašeho požadavku také JSON, formulář nebo soubor. Díky tomu můžete zadat nová data ručně nebo pomocí proměnných, takže můžete do API odeslat data pro vytvoření, nahrazení nebo úpravu položky.Chcete‑li zkratku vyzkoušet, klepněte na
.
Na první pohled vypadají data vrácená rozhraním API jen jako nepřehledná změť textu. Tato data jsou zakódována ve formátu JSON, což je zkratka pro JavaScript Object Notation.
Informace o práci s formátem JSON a pokračování příkladu s API od Typicode najdete v tématu Úvod do používání formátu JSON ve Zkratkách na iPhonu a iPadu.