Cvičení – volání rozhraní API s klíčem předplatného

  • 5 min

Klíč předplatného je jedním ze způsobů, jak omezit přístup k rozhraní API.

V příkladu obuvnické společnosti pracuje společnost NorthWind Shoes s dodavatelem a chce, aby měl přímý přístup k rozhraní API inventáře. Přístup partnera musí být omezený pomocí klíče předplatného pro všechna volání rozhraní API.

Tady získáte klíč předplatného pro vaše rozhraní API. Pak otestujete přístup k rozhraní API pomocí klíče předplatného a bez klíče předplatného.

Získání klíče předplatného

Partneři získají klíč jako součást procesu onboardingu. V tomto cvičení přidáte předplatné speciálně pro rozhraní NorthWindShoes API. Jakmile máte klíč, postupujte podle standardního procesu pro použití klíče ve voláních rozhraní API.

  1. V nabídce webu Azure Portal nebo na domovské stránce vyberte Všechny prostředky a pak vyberte instanci služby API Management.

  2. V levém podokně nabídek v části Rozhraní API vyberte Předplatná.

  3. Vyberte + Předplatné a pro každé nastavení zadejte následující hodnoty. Pak vyberte Vytvořit.

    Nastavení Hodnota
    Name NorthWind
    Zobrazované jméno NorthWind subscription
    Obor Vyberte rozhraní API a pak v rozevíracím seznamu vyberte Produkty NorthWindShoes .

  4. Vyberte místní nabídku (...) pro předplatné Northwind a pak vyberte Zobrazit nebo skrýt klíče.

  5. Vyberte tlačítko Kopírovat kliknutím pro PRIMÁRNÍ KLÍČ.

  6. Tento klíč někam uložte, například do Poznámkového bloku.

Použití klíče předplatného ve volání rozhraní API

Dalším krokem je použití klíče předplatného k otestování přístupu vývojáře k vašemu publikovanému rozhraní API.

  1. Spuštěním následujícího příkazu v Cloud Shellu získejte přístup k operaci Products ve vašem rozhraní API a nahraďte <apim gateway> názvem brány.

    curl https://<apim gateway>.azure-api.net/api/Products

    Zobrazí se zpráva 401, Přístup byl odepřen kvůli chybějící zprávě klíče předplatného.

  2. Teď opakujte požadavek curl, tentokrát včetně klíče předplatného.

  3. Spuštěním následujícího příkazu v Cloud Shellu nahraďte <primary key> dříve uloženým klíčem a nahraďte <apim gateway> názvem vaší brány.

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

    Teď byste měli být schopni přistoupit k rozhraní API a zobrazit seznam produktů vrácený do konzoly.