Volání rozhraní API s klíčem předplatného

  • 5 min

Když publikujete rozhraní API, často chcete mít určitou úroveň kontroly nad tím, kdo může přes bránu k rozhraní API přistupovat. Klíče předplatného představují jeden ze způsobů, jak omezit přístup k rozhraní API.

Tady se dozvíte, jak pomocí klíčů předplatného zabezpečit vaše rozhraní API.

Předplatná a klíče

Pokud chcete rozhraní API chránit, můžete použít klíč předplatného.

Poznámka:

V produkčních prostředích SLUŽBY API Management obvykle zkombinujete klíč předplatného s jinými mechanismy, které chrání vaše rozhraní API před neoprávněným použitím, jako je ověřování certifikátů nebo autorizace OAuth 2.0. Toto jsou mimo rozsah tohoto modulu.

Klíč předplatného je jedinečný automaticky vygenerovaný řetězec, který se předává v hlavičce požadavku klienta nebo jako řetězec dotazu v adrese URL. Klíč přímo souvisí s předplatným, které je možné vymezit na různé oblasti a poskytuje podrobnou kontrolu nad oprávněními a zásadami. Hlavní obory předplatného jsou:

  • Všechna rozhraní API
  • Jedno rozhraní API
  • Produkt

Aplikace, která volá chráněné rozhraní API, musí v požadavku obsahovat klíč.

Tyto klíče předplatného můžete kdykoli znovu vygenerovat. Pokud máte například podezření, že se klíč sdílí s neoprávněnými uživateli, znovu vygenerujte klíče předplatného.

Subscription keys.

Každé předplatné má dva klíče, primární a sekundární. Když potřebujete znovu vygenerovat klíč, můžete mít dva klíče jednodušší. Pokud například chcete změnit primární klíč a vyhnout se tak výpadku, použijte ve svých aplikacích sekundární klíč.

Když voláte rozhraní API v produktech s povolenými předplatnými, musíte zadat klíč. Jako vývojář můžete klíč získat odesláním žádosti o předplatné. Tento proces je základní součástí pracovního postupu služby API Management.

Poznámka:

Vytvoření nových uživatelů a poskytnutí klíčů předplatného, aby měli přístup k rozhraní API, je základní součástí pracovního postupu služby API Management, ale je mimo rozsah tohoto modulu.

Volání rozhraní API s klíčem předplatného

Aplikace musí zahrnovat platný klíč ve všech požadavcích HTTP při volání do koncových bodů rozhraní API, které jsou chráněny předplatným. Klíče lze předávat v hlavičce žádosti nebo jako řetězec dotazu v adrese URL.

Výchozí název hlavičky je Ocp-Apim-Subscription-Key a výchozí řetězec dotazu je subscription-key.

K otestování volání rozhraní API můžete použít portál pro vývojáře (pokud je dostupný ve vaší úrovni služby), nástroj příkazového řádku, jako je curl nebo jiné nástroje, jako je Postman.

Tady je příklad požadavku GET, který předává klíč v hlavičce požadavku pomocí příkazu curl :

curl --header "Ocp-Apim-Subscription-Key: <key string>" https://<apim gateway>.azure-api.net/api/path

Tady je příklad příkazu curl, který předá klíč v adrese URL jako řetězec dotazu:

curl https://<apim gateway>.azure-api.net/api/path?subscription-key=<key string>

Pokud klíč není předán v hlavičce nebo jako řetězec dotazu v adrese URL, získáte odpověď 401 Přístup odepřen z brány rozhraní API.