Kurz: Vytvoření a publikování produktu
PLATÍ PRO: Všechny úrovně služby API Management
Ve službě Azure API Management obsahuje produkt jedno nebo více rozhraní API, kvótu využití a podmínky použití. Po publikování produktu se můžou vývojáři přihlásit k odběru produktu a začít používat rozhraní API produktu.
V tomto kurzu se naučíte:
- Vytvoření a publikování produktu
- Přidání rozhraní API do produktu
- Přístup k rozhraním API produktů
Požadavky
- Seznamte se s terminologií služby Azure API Management.
- Projděte si následující rychlý start: Vytvoření instance Azure API Managementu.
- Projděte si také následující kurz: Navíc kurzu: Import a publikování vašeho prvního rozhraní API.
Vytvoření a publikování produktu
Přihlaste se k webu Azure Portal a přejděte k vaší instanci služby API Management.
V levém navigačním podokně vyberte Products+ Add (Produkty>+ Přidat).
V okně Přidat produkt zadejte hodnoty popsané v následující tabulce a vytvořte produkt.
Název Popis Zobrazovaný název Název, jak chcete, aby se zobrazoval na portálu pro vývojáře. Popis Zadejte informace o produktu, jako je jeho účel, rozhraní API, ke které poskytuje přístup, a další podrobnosti. Stav Pokud chcete produkt publikovat, vyberte Možnost Publikováno . Předtím, než bude možné volat rozhraní API v produktu, je nutné produkt publikovat. Ve výchozím nastavení se nové produkty nepublikují a jsou viditelné pouze pro skupinu Správa istrators. Vyžaduje předplatné Vyberte, jestli se uživatel vyžaduje k přihlášení k odběru produktu (produkt je chráněný) a klíč předplatného se musí použít pro přístup k rozhraním API produktu. Pokud se předplatné nevyžaduje (produkt je otevřený), klíč předplatného se pro přístup k rozhraním API produktu nevyžaduje. Viz Přístup k rozhraním API produktů dále v tomto článku. Vyžaduje schválení Vyberte, jestli má správce zkontrolovat a přijmout nebo odmítnout pokusy o předplatné pro tento produkt. Pokud není vybraná, pokusy o předplatné se automaticky schválí. Omezení počtu předplatných Volitelně můžete omezit počet více souběžných předplatných. Právní podmínky Pro produkt můžete zahrnout podmínky použití, které musí předplatitelé přijmout, aby mohli produkt využívat. Rozhraní API Vyberte jedno nebo více rozhraní API. Po vytvoření produktu můžete také přidat rozhraní API. Další informace najdete v tématu Přidání rozhraní API do produktu dále v tomto článku.
Pokud je produkt otevřený (nevyžaduje předplatné), můžete přidat jenom rozhraní API, které není přidružené k jinému otevřenému produktu.Vyberte Vytvořit a vytvořte nový produkt.
Upozornění
Při konfiguraci produktu, který nevyžaduje předplatné, používejte péči. Tato konfigurace může být příliš přesvědčivá a může usnadnit rozhraní API produktu vůči určitým hrozbám zabezpečení rozhraní API.
Přidání více konfigurací
Po uložení produktu pokračujte v konfiguraci. V instanci služby API Management vyberte produkt v okně Produkty . Přidání nebo aktualizace:
Položka | Popis |
---|---|
Nastavení | Metadata a stav produktu |
Rozhraní API | Rozhraní API přidružená k produktu |
Zásady | Zásady použité na rozhraní API produktů |
Řízení přístupu | Viditelnost produktů pro vývojáře nebo hosty |
Předplatná | Předplatitelé produktů |
Přidání rozhraní API do produktu
Produkty jsou sdruženími jednoho nebo více rozhraní API. Můžete zahrnout mnoho rozhraní API a nabídnout je vývojářům prostřednictvím portálu pro vývojáře. Během vytváření produktu můžete přidat jedno nebo více existujících rozhraní API. Rozhraní API můžete do produktu přidat také později, a to buď na stránce Produkty Nastavení, nebo při vytváření rozhraní API.
Přidání rozhraní API do existujícího produktu
- V levém navigačním panelu vaší instance služby API Management vyberte Produkty.
- Vyberte produkt a pak vyberte rozhraní API.
- Vyberte + Přidat rozhraní API.
- Vyberte jedno nebo více rozhraní API a pak vyberte.
Přístup k rozhraním API produktů
Po publikování produktu můžou vývojáři přistupovat k rozhraním API. V závislosti na tom, jak je produkt nakonfigurovaný, může být potřeba přihlásit se k odběru produktu pro přístup.
Chráněný produkt – Vývojáři se musí nejdřív přihlásit k odběru chráněného produktu, aby získali přístup k rozhraním API produktu. Když se přihlásí k odběru, získá klíč předplatného, který má přístup k libovolnému rozhraní API v daném produktu. Pokud jste vytvořili instanci služby API Management, jste již správcem, takže jste přihlášeni k odběru všech produktů ve výchozím nastavení. Další informace najdete v tématu Předplatná ve službě Azure API Management.
Když klient vytvoří požadavek rozhraní API s platným kódem Product Subscription Key, služba API Management žádost zpracuje a povolí přístup v kontextu produktu. Můžete použít zásady a pravidla řízení přístupu nakonfigurovaná pro produkt.
Tip
Předplatné uživatele můžete vytvořit nebo aktualizovat na produkt pomocí vlastních klíčů předplatného prostřednictvím rozhraní REST API nebo příkazu PowerShellu.
Otevřený produkt – Vývojáři mají přístup k rozhraním API otevřeného produktu bez klíče předplatného. Můžete ale nakonfigurovat další mechanismy pro zabezpečení přístupu klientů k rozhraním API, včetně OAuth 2.0, klientských certifikátů a omezení IP adres volajícího.
Poznámka:
Otevřené produkty nejsou uvedené na portálu pro vývojáře, aby se o něm vývojáři dozvěděli nebo se přihlásili k jejich odběru. Jsou viditelné pouze pro skupinu Správa istrátory. K informování vývojářů o rozhraních API, ke kterým mají přístup bez klíče předplatného, budete muset použít jiný mechanismus.
Když klient vytvoří požadavek rozhraní API bez klíče předplatného:
SLUŽBA API Management zkontroluje, jestli je rozhraní API přidružené k otevřenému produktu. Rozhraní API může být přidružené maximálně k jednomu otevřenému produktu.
Pokud otevřený produkt existuje, zpracuje požadavek v kontextu tohoto otevřeného produktu. Můžete použít zásady a pravidla řízení přístupu nakonfigurovaná pro otevřený produkt.
Další informace najdete v tématu Jak služba API Management zpracovává požadavky s klíči předplatného nebo bez.
Další kroky
V tomto kurzu jste se naučili, jak:
- Vytvoření a publikování produktu
- Přidání rozhraní API do produktu
- Přístup k rozhraním API produktů
Přejděte k dalšímu kurzu: