연습 - 구독 키를 사용하여 API 호출

  • 5분

구독 키는 API에 대한 액세스를 제한하는 방법 중 하나입니다.

신발 회사의 예에서 NorthWind Shoes는 공급업체와 협력하고 있으며 재고 API에 직접 액세스하려고 합니다. API에 대한 모든 호출에 구독 키를 사용하여 파트너 액세스를 제한해야 합니다.

여기에서 API에 대한 구독 키를 얻습니다. 그런 다음, 구독 키를 사용할 때와 사용하지 않을 때의 API에 대한 액세스를 테스트합니다.

구독 키 가져오기

온보딩 프로세스의 일환으로 파트너에게 키를 제공합니다. 이 연습에서는 특별히 NorthWindShoes API에 대한 구독을 추가합니다. 키를 받으면 API 호출에서 키를 사용하기 위한 표준 프로세스를 따릅니다.

  1. Azure Portal 메뉴 또는 홈페이지에서 모든 리소스를 선택하고 API Management 인스턴스를 선택합니다.

  2. 왼쪽 메뉴 창의 API에서 구독을 선택합니다.

  3. + 구독을 선택하고 각 설정에 대해 다음 값을 입력합니다. 그런 다음 만들기를 선택합니다.

    설정 값
    이름 NorthWind
    표시 이름 NorthWind subscription
    범위 API를 선택한 다음 드롭다운 목록에서 NorthWindShoes Products를 선택합니다.

  4. Northwind 구독에 대한 바로 가기 메뉴(...)를 선택한 다음 키 표시/숨기기를 선택합니다.

  5. 기본 키에 대한 복사하려면 클릭을 선택합니다.

  6. 이 키를 메모장과 같은 어딘가에 저장합니다.

API 호출에서 구독 키 사용

다음 단계는 구독 키를 사용하여 게시된 API에 대한 개발자 액세스를 테스트하는 것입니다.

  1. Cloud Shell에서 다음 명령을 실행하여 API에서 제품 작업에 액세스하고 <apim gateway>를 게이트웨이 이름으로 바꿉니다.

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

    401, 구독 키가 누락되어 액세스가 거부되었습니다라는 메시지가 표시됩니다.

  2. 이번에는 구독 키를 사용하여 curl 요청을 반복합니다.

  3. Cloud Shell에서 다음 명령을 실행하여 <primary key>를 이전에 저장한 키로 바꾸고, <apim gateway>를 게이트웨이 이름으로 바꿉니다.

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

    이제는 API에 액세스하여 콘솔에 반환된 제품 목록을 볼 수 있습니다.