직접 관리 API Management REST API

  • 아티클

Azure API Management 사용자, 그룹, 제품 및 구독과 같은 선택한 엔터티에 대한 작업을 수행하기 위한 직접 관리 REST API를 제공합니다. 직접 관리 API는 요청 제한과 같은 Azure Resource Manager 기반 API의 특정 제한을 무시할 수 있습니다.

중요

이 섹션에서는 직접 관리 API Management REST API에 액세스하는 방법을 설명합니다. 이 API에는 Azure Resource Manager 다른 인증 메커니즘이 있으며 다른 기본 URL을 사용합니다.

직접 관리 REST API에 대한 액세스 사용

호출이 성공적으로 이루어지려면 먼저 직접 관리 API Management REST API에 대한 액세스 권한을 부여해야 합니다.

  1. Azure Portal에서 Azure API Management 인스턴스를 찾습니다.

  2. 왼쪽 메뉴의 배포 + 인프라 섹션에서 관리 API를 선택합니다.

    Azure Portal 관리 API를 선택합니다.

  3. API MANAGEMENT REST API 사용에서 예를 선택합니다.

    중요

    API Management REST API 사용을 선택하지 않으면 해당 서비스 instance 대한 REST API에 대한 호출이 실패합니다.

    Azure Portal API Management API 사용

기본 미디어 유형

요청 및 응답의 기본 미디어 유형은 application/json입니다. 언급되어 있는 경우 일부 작업은 다른 콘텐츠 형식을 지원합니다. 특정 작업에 대해 추가 콘텐츠 형식이 언급되어 있지 않은 경우 미디어 유형은 application/json입니다.

인증

다음 예제와 같이 API Management REST API에 대한 각 요청에는 유효한 공유 액세스 토큰이 포함된 헤더가 포함되어 Authorization 야 합니다.

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

이 액세스 토큰은 프로그래밍 방식으로 생성하거나 API 관리 게시자 포털 내에서 생성할 수 있습니다. 액세스 토큰을 생성하고 검색하는 방법에 대한 지침은 액세스 토큰을 수동으로 만들려면 및 프로그래밍 방식으로 액세스 토큰을 만들려면를 참조하세요.

기준 URL

직접 관리 API Management REST API의 기본 URL은 다음 템플릿을 준수합니다.

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

이 템플릿에는 다음과 같은 매개 변수가 포함되어 있습니다.

  • {serviceName}은 서비스가 만들어지는 동안 지정된 서비스 이름입니다(예: https://contosoapi.management.azure-api.net).

API Management REST API에서 반환되는 모든 URL은 이 기본 URL을 기준으로 하며 REST API에 대한 모든 요청은 이 기본 URL 템플릿을 사용해야 합니다.

버전 쿼리 매개 변수

모든 작업에서는 api-version 형식의 값을 가진 YYYY-MM-DD 쿼리 매개 변수를 요구합니다(예: 2021-08-01).

참고

API Management REST API -preview 에 대한 미리 보기 기간 동안 은 버전 쿼리 매개 변수(예2021-04-01-preview: )에 추가됩니다.

이 쿼리 매개 변수가 요청의 쿼리 문자열에 전달되지 않으면 서버는 의 상태 코드를 400 Bad Request반환합니다. 지원되는 버전 목록은 API Management REST API 참조를 참조하세요.

다음 단계

  • 인증에 대해 자세히 알아봅니다.