2부: API 키 생성 및 테스트

<ph type="x-smartling-placeholder"></ph> 현재 Apigee Edge 문서를 보고 있습니다.
Apigee X 문서. 정보

리팩터링 및 리디렉션 후 API 키가 필요함

개발자는 개발자의 API에 요청하여 API를 제공하는 앱을 백엔드 서비스에 액세스할 수 있습니다 API에 대한 액세스를 제어하려면 개발자에게 다음을 수행하도록 요청할 수 있습니다. API 키를 전달합니다 키가 누락되거나 잘못되면 요청이 실패합니다.

게시는 있습니다 게시 API는 다음 작업으로 광범위하게 정의할 수 있습니다.

1. Apigee Edge에서 API를 번들로 묶는 API 제품을 만듭니다.
2. Edge에 앱 개발자 등록 등록된 앱 개발자만 앱을 등록할 수 있습니다.
3. 개발자는 Edge에 앱을 등록하여 API 제품에 액세스합니다. 이에 대응하여 개발자는 API 키를 받습니다 이제 개발자가 API 키를 가지고 있으므로 API에 액세스할 수 있습니다

자세한 내용은 소개 게시 중 한 가지를 선택합니다.

다음 표에는 앱 등록 및 키 생성에 사용되는 몇 가지 용어가 정의되어 있습니다.

이 튜토리얼의 기본 요건

이 튜토리얼에서는 API를 만드는 첫 번째 튜토리얼을 완료했다고 가정합니다. Yahoo 날씨 API에 액세스할 수 있습니다. 첫 번째 튜토리얼을 아직 완료하지 않았다면 다음을 참조하세요. API 키를 사용하도록 요청할 수 있습니다.

1단계: API 제품 만들기

1. 관리 UI에서 게시 탭을 클릭한 다음 제품.
2. (+) 제품을 클릭합니다.
3. '제품 추가' 대화상자 필드에 다음을 입력하거나 선택합니다.

   필드	값
   이름	무료 API 제품
   표시 이름	무료 API 제품
   설명	무료 API 제품
   환경	테스트
   액세스	내부 전용
   키 승인 유형	자동 (API 키는 생성 후 자동으로 승인됨)
   할당량	1시간당 요청 10개 (요청 수를 시간당 10회로 제한)
   허용된 OAuth 범위	비워두기

   채워진 대화상자는 다음과 같습니다.

   

4. 리소스 섹션에서 다음을 선택합니다. <ph type="x-smartling-placeholder">
   </ph>
   • API 프록시: weatherapikey
   • 버전: 1
   • 리소스 경로: /forecastrss**
     <ph type="x-smartling-placeholder">
     </ph> 리소스 경로는 제품에서 허용하는 리소스 URI를 지정합니다. 액세스할 수 있습니다. 이 예에서 앱은 /forecastrss weatherapikey 프록시에서 리소스를 사용할 수 있습니다. 사용 시도 중 weatherapiproxy 프록시의 다른 리소스에 액세스할 수 있는 API 제품 또는 다른 모든 프록시는 금지됩니다.
     
     리소스 경로에는 와일드 카드 문자를 사용할 수 있습니다. 와일드 카드 '/**' 은 모든 하위 URI가 포함되어 있음을 나타냅니다. 즉, /forecastrss/foo/bar. 와일드 카드 '/' 한 단계 아래의 URI만 포함됩니다. API 만들기를 참조하세요. 자세히 알아보세요.
     
     리소스 경로 드롭다운 목록에는 지정된 API 프록시에 정의된 흐름을 정의합니다. API 프록시의 조건부 흐름은 리소스 경로와 연관된 로직 또는 처리 단계 API 제품이 액세스를 제어합니다. 리소스 경로에 적용할 수 있습니다
     
5. 리소스 가져오기를 클릭합니다. 리소스 경로가 추가되고 weatherapikey API 프록시는 다음을 위한 API 프록시에 자동으로 추가됩니다. 제품 섹션을 참고하세요.
6. 저장을 클릭합니다. 새 제품이 제품 페이지에 등록됩니다.

자세히 알아보기:

• API 제품 만들기

2단계: 개발자 등록하기

API 키를 생성하려면 앱을 등록하고 API 제품에 연결해야 합니다. 하지만 앱을 등록할 수 있으려면 먼저 앱 개발자를 등록해야 합니다.

1. 관리 UI에서 게시 탭을 클릭한 다음 개발자.
2. (+) 개발자를 클릭합니다.
3. New Developer 대화상자에 다음 값을 입력합니다. <ph type="x-smartling-placeholder">
   </ph>
   • 이름: Jane
   • 성: 튜토리얼
   • 이메일 주소: janetutorial@example.com
   • 사용자 이름: jtutorial
4. 저장을 클릭합니다. 새 개발자가 개발자 페이지

자세히 알아보기:

• 관리 앱 개발자

3단계: 앱 등록하기

이제 API 제품과 개발자가 있으므로 API에 앱을 등록할 수 있습니다. 있습니다. 앱을 등록하면 앱과 연결된 API 제품의 API 키가 생성됩니다. 그런 다음 API의 기능에 액세스할 수 있도록 키를 앱 개발자에게 배포할 수 있습니다. 제품 판매가 가능합니다.

1. API 플랫폼 UI에서 게시 탭을 클릭한 다음 개발자를 클릭합니다. 앱을 클릭합니다.
2. (+) 개발자 앱을 클릭합니다.
3. Add an App 대화상자에서 다음 값을 입력합니다. <ph type="x-smartling-placeholder">
   </ph>
   • 표시 이름: Weather API 키 앱
   • 개발자: 제인 튜토리얼 (janetutorial@example.com)
   • Callback URL(콜백 URL): 비워 둡니다.
4. 앱을 제품과 연결: <ph type="x-smartling-placeholder">
   </ph>
   1. 제품 섹션에서 + 제품을 클릭합니다.
   2. 무료 API 제품을 선택합니다.
   3. 체크표시 아이콘을 클릭하여 변경사항을 수락합니다.
5. 저장을 클릭합니다. 새 앱이 개발자의 앱 목록에 표시됩니다. 앱 페이지로 이동합니다.
6. Weather API Key App을 선택합니다. 앱 목록에 표시됩니다. 그러면 앱의 세부정보 페이지가 열립니다.
7. API를 만들 때 키 승인 유형: 자동을 선택했기 때문입니다. API 키가 자동으로 승인되어 즉시 볼 수 있습니다. (만약 승인 유형: 수동을 선택한 경우에는 무료 API 제품의 작업 열에서 승인하여 API를 승인합니다. key.)
8. 제품 섹션에서 무료 API 제품 항목 옆에 있는 소비자 키 및 고객 보안 비밀에 표시 열을 사용하여 생성된 키를 표시합니다.
   

   고객 키는 API 키의 다른 이름이며 앱이 필요로 하는 유일한 키입니다. forecast 리소스에 액세스 API 프록시 를 통해 액세스할 수 있습니다 . 고객 비밀번호는 고객 키와 함께 보안 기능을 자세히 살펴봤습니다 예를 들어 OAuth 2.0: 새 API 프록시 구성

자세히 알아보기:

• 앱과 API 키 관리를 참조하세요.

4단계: 요청에 API 키 사용하기

VerifyAPIKey 정책이 올바르게 작동하는지 확인하려면 유효한 API 키로 API 프록시를 호출합니다. 브라우저에서 API 프록시를 요청할 수 있습니다. Apigee Console에서 또는 cURL을 사용하여 API 프록시의 trace 페이지입니다. 요청할 URL이 양식:

http://{org-name}-test.apigee.net/v1/weatherapikey/forecastrss?w=12797282&apikey=IEYRtW2cb7A5Gs54A1wKElECBL65GVls

{org-name} 및 올바른 apikey 값을 Apigee 조직 이름으로 바꿉니다.

응답에서 다음 내용을 찾습니다.

<rss xmlns:yweather="http://xml.weather.yahoo.com/ns/rss/1.0" xmlns:geo="http://www.w3.org/2003/01/geo/wgs84_pos#" version="2.0"> 
<channel> <title>Yahoo! Weather - Palo Alto, CA</title> 
<link>http://us.rd.yahoo.com/dailynews/rss/weather/Palo_Alto__CA/*http://weather.yahoo.com/forecast/USCA1093_f.html</link> 
<description>Yahoo! Weather for Palo Alto, CA</description> <language>en-us</language>

요청에서 API 키를 생략하거나 잘못된 키 값이 포함된 경우 다음 형식의 오류 응답이 표시됩니다.

{"fault":{"faultstring":"Failed to resolve API Key variable null","detail":{"errorcode":"steps.oauth.v2.FailedToResolveAPIKey"}}}

5단계: 다음 단계

이제 쿼리 매개변수를 사용하여 API에 요청하여 API 키를 전달했습니다. 키를 헤더로 전달하도록 API를 수정합니다.