Sdílet prostřednictvím

Přímá správa API Management ROZHRANÍ REST API

  • Článek

Azure API Management poskytuje rozhraní REST API pro přímou správu pro provádění operací s vybranými entitami, jako jsou uživatelé, skupiny, produkty a předplatná. Rozhraní API pro přímou správu může obejít určitá omezení rozhraní API založeného na Azure Resource Manager, jako je omezování požadavků.

Důležité

Tato část popisuje, jak získat přístup k přímé správě API Management ROZHRANÍ REST API. Toto rozhraní API má jiný mechanismus ověřování než Azure Resource Manager a používá jinou základní adresu URL.

Povolení přístupu k rozhraní REST API přímé správy

Před úspěšným voláním je potřeba udělit přístup k rozhraní REST API pro přímou správu API Management.

  1. V Azure Portal přejděte ke své instanci Azure API Management.

  2. V části Nasazení a infrastruktura nabídky na levé straně vyberte Rozhraní API pro správu.

    V Azure Portal vyberte rozhraní API pro správu.

  3. V části Povolit API Management REST API vyberte Ano.

    Důležité

    Pokud není vybraná možnost Povolit rozhraní REST API API Management, volání rozhraní REST API pro tuto instanci služby selžou.

    Povolení rozhraní API API Management v Azure Portal

Výchozí typ média

Výchozí typ média pro požadavky a odpovědi je application/json. Pokud je uvedeno, některé operace podporují jiné typy obsahu. Pokud pro určitou operaci není uveden žádný další typ obsahu, je application/jsontyp média .

Authentication

Každý požadavek na rozhraní API MANAGEMENT REST API musí být doprovázen hlavičkou Authorization obsahující platný sdílený přístupový token, jak je znázorněno v následujícím příkladu.

Authorization: SharedAccessSignature uid=53dd860e1b72ff0467030003&ex=2014-08-04T22:03:00.0000000Z&sn=ItH6scUyCazNKHULKA0Yv6T+Skk4bdVmLqcPPPdWoxl2n1+rVbhKlplFrqjkoUFRr0og4wjeDz4yfThC82OjfQ==

Tento přístupový token je možné vygenerovat programově nebo z portálu vydavatele API Management. Pokyny ke generování a načítání přístupového tokenu najdete v tématech Ruční vytvoření přístupového tokenu a Vytvoření přístupového tokenu prostřednictvím kódu programu.

Základní adresa URL

Základní adresa URL přímé správy API Management rozhraní REST API odpovídá následující šabloně.

https://{servicename}.management.azure-api.net

Tato šablona obsahuje následující parametr.

  • {serviceName} je název služby, jak byl zadán při vytváření služby, například https://contosoapi.management.azure-api.net.

Všechny adresy URL vrácené rozhraním API MANAGEMENT REST API jsou relativní vzhledem k této základní adrese URL a všechny požadavky na rozhraní REST API musí používat tuto šablonu základní adresy URL.

Parametr dotazu verze

Všechny operace očekávají api-version parametr dotazu s hodnotou ve formátu YYYY-MM-DD, například 2021-08-01.

Poznámka

Během období Preview pro rozhraní REST API -preview API Management se k parametru dotazu verze připojí, například 2021-04-01-preview.

Pokud se tento parametr dotazu nepředá v řetězci dotazu požadavku, server vrátí stavový kód 400 Bad Request. Seznam podporovaných verzí najdete v referenčních informacích k rozhraní REST API API Management.

Další kroky