Kurz: Vytvoření a publikování produktu

V Azure API Management produkt obsahuje 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 produktu

API Management produkty na portálu

Požadavky

Vytvoření a publikování produktu

  1. Přihlaste se k Azure Portal a přejděte na instanci API Management.

  2. V levém navigačním podokně vyberte Produkty>+ Přidat.

    Přidání produktu do Azure Portal

  3. V okně Přidat produkt zadejte hodnoty popsané v následující tabulce a vytvořte produkt.

    Okno Přidat produkt

    Název Description
    Zobrazované jméno Název, jak chcete, aby se zobrazoval na portálu pro vývojáře.
    Description Uveďte informace o produktu, jako je jeho účel, rozhraní API, ke které poskytuje přístup, a další podrobnosti.
    Stav Vyberte Publikovat , pokud chcete produkt publikovat. 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é jenom skupině Administrators .
    Vyžaduje předplatné Vyberte, jestli je uživatel nutný 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 předplatné není povinné (produkt je otevřený), klíč předplatného se nevyžaduje pro přístup k rozhraním API produktu. Další informace najdete v části Access 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 k 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.
  4. 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š náchylná a může být rozhraní API produktu zranitelnější vůči určitým hrozbám zabezpečení rozhraní API.

Přidání více konfigurací

Po uložení pokračujte v konfiguraci produktu. V API Management instanci 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é pro 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ď ze stránky Nastavení produktů, nebo při vytváření rozhraní API.

Přidání rozhraní API do existujícího produktu

  1. V levém navigačním panelu vaší instance API Management vyberte Produkty.
  2. Vyberte produkt a pak vyberte rozhraní API.
  3. Vyberte + Přidat rozhraní API.
  4. Vyberte jedno nebo více rozhraní API a pak vyberte.

Přidání rozhraní API do existujícího produktu

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í nejprve 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 API Management, jste již správcem, takže jste ve výchozím nastavení přihlášení k odběru každého produktu. Další informace najdete v tématu Předplatná v Azure API Management.

    Když klient vytvoří požadavek rozhraní API s platným kódem Product Subscription Key, API Management zpracuje požadavek 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 powershellového příkazu.

  • Otevřený produkt – Vývojáři mají přístup k rozhraním API otevřených produktů 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 tom vývojáři dozvěděli nebo se přihlásili k odběru. Zobrazí se jenom skupině Administrators . Budete muset použít jiný mechanismus k informování vývojářů o rozhraních API, ke kterým je možné přistupovat bez klíče předplatného.

    Když klient vytvoří požadavek rozhraní API bez klíče předplatného:

    • API Management zkontroluje, jestli je rozhraní API přidružené k 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 API Management zpracovávat požadavky s klíči předplatného nebo bez předplatného.

Další kroky

V tomto kurzu jste se naučili:

  • Vytvoření a publikování produktu
  • Přidání rozhraní API do produktu
  • Přístup k rozhraním API produktu

Přejděte k dalšímu kurzu: