앱 등록 구성

현재 Apigee Edge 문서가 표시되고 있습니다.
Apigee X 문서로 이동 정보

개발자는 개발자 서비스 포털의 내 앱 페이지를 사용하여 앱을 등록합니다. 개발자는 포털의 기본 메뉴에서 내 앱 페이지에 액세스할 수 있습니다.

새 앱을 등록하려면 개발자는 내 앱 페이지에서 '새 앱 추가' 버튼을 선택합니다.

그러면 포털에 기본 앱 등록 양식이 표시됩니다.

기본적으로 개발자는 앱 이름, 콜백 URL, 앱에 추가할 API 제품 목록만 지정하면 됩니다.

API 제공업체는 앱 등록 프로세스를 완벽하게 제어할 수 있습니다. 예를 들어 다음을 구성할 수 있습니다.

  • 포털에서 사용할 수 있는 API 제품 목록입니다.
  • 기본 API 제품이 있는지 여부
  • 콜백 URL이 필요한지 여부
  • API 제품에 대해 API 키가 수동 또는 자동으로 승인되는지 여부
  • 앱을 등록하기 위해 앱 추가 페이지에 다른 정보가 필요한지 여부

이 주제에서는 포털에 앱 등록 프로세스를 구성하는 방법을 설명합니다. 그러나 이 주제에서는 API 제품을 만드는 방법을 설명하지 않습니다. 자세한 내용은 다음을 참고하세요.

개발자에게 할당된 역할에 따라 개발자가 앱을 생성, 삭제, 수정할 수 없도록 포털을 구성할 수 있습니다. 예를 들어 개발자가 등록할 때 모든 개발자를 위한 단일 기본 앱을 만들도록 포털을 구성할 수 있습니다. 그런 다음 일부 개발자만 요금 구조나 기타 개발자의 특성에 따라 새 앱을 추가하도록 허용할 수 있습니다. 역할과 권한을 사용하여 앱을 생성, 삭제, 수정할 수 있는 개발자를 관리합니다. 자세한 내용은 사용자 계정 추가 및 관리를 참고하세요.

포털에서 사용 가능한 API 제품 지정

개발자가 포털에 액세스할 때 사용할 수 있는 API 제품을 지정하는 방법에는 두 가지가 있습니다.

API 제품을 만들 때 액세스 수준 지정

API 제품을 만들 때 아래와 같이 제품의 액세스 수준 옵션을 지정합니다.

Drupal 7 개발자 포털에서 액세스 수준이 API 제품 가용성에 미치는 영향에 대한 자세한 내용은 액세스 수준을 참고하세요.

역할에 따라 API 제품에 대한 액세스 제한

API 제품 역할 액세스 Drupal 모듈을 사용 설정하면 각 API 제품에 액세스할 수 있는 역할을 지정할 수 있습니다.

개발자 역할에 따라 API 제품에 대한 액세스를 제한하려면 다음 단계를 따르세요.

  1. 관리자 또는 콘텐츠 생성 권한이 있는 사용자로 포털에 로그인합니다.
  2. 개발자 포털 역할 및 사용자 할당을 검토합니다.
    • Drupal 관리 메뉴에서 사용자 > 권한 > 역할을 선택하고 필요에 따라 개발자 역할 및 권한을 추가하거나 수정합니다.
    • Drupal 관리 메뉴에서 사용자를 선택하고 필요에 따라 사용자 및 역할 할당을 수정합니다.
  3. Drupal 관리 메뉴에서 구성 > 개발자 포털 > API 제품 역할 액세스를 선택합니다.
  4. 각 API 제품에 대한 액세스 권한을 부여하려는 역할을 선택하세요.
  5. 구성 저장을 클릭합니다.

개발자가 API 제품을 앱에 연결하는 방법 구성

새 앱을 등록하려면 개발자는 내 앱 페이지에서 '새 앱 추가' 버튼을 선택하여 앱 추가 양식을 엽니다.

포털 구성 방법에 따라 개발자는 앱 등록 시 앱과 연결할 API 제품을 하나 이상 선택할 수 있습니다. 또는 모든 앱에 할당되는 기본 제품을 지정할 수 있습니다.

앱을 등록할 때 포털에서 다음 구성 옵션을 사용하여 API 제품 선택을 제어할 수 있습니다.

  • 앱을 API 제품과 연결해서는 안 됩니다.
  • 모든 앱을 하나 이상의 기본 API 제품 (아래에 구성됨)과 연결합니다. 개발자는 다른 API 제품을 앱에 추가할 수 없습니다.
  • 단일 API 제품을 선택할 수 있지만 필수는 아닙니다.
  • 단일 API 제품을 선택해야 합니다.
  • 여러 API 제품을 선택할 수 있지만 필수는 아닙니다.
  • 여러 API 제품을 선택할 수 있으며 하나 이상이 필요합니다.

개발자가 API 제품을 선택하는 데 사용하는 양식에 표시되는 HTML 요소를 제어할 수도 있습니다. 옵션은 다음과 같습니다.

  • 드롭다운 목록.
  • 체크박스 또는 라디오 버튼 체크박스는 개발자가 여러 API 제품을 선택할 수 있는 경우 표시되고 개발자가 단일 API 제품만 선택할 수 있는 경우 라디오 버튼이 표시됩니다.

API 제품 선택 옵션을 설정하려면 다음 안내를 따르세요.

  1. 관리자 또는 콘텐츠 생성 권한이 있는 사용자로 포털에 로그인합니다.
  2. Drupal 관리 메뉴에서 Configuration > Dev Portal Settings > Application Settings를 선택합니다.
  3. 애플리케이션 설정 페이지에서 API 제품 설정 영역을 펼칩니다.
  4. API 제품 처리에서 API 제품 선택을 제어하는 옵션을 선택합니다.
  5. '모든 앱을 하나 이상의 기본 API 제품과 연결(아래 구성)' 옵션을 지정하는 경우 기본 API 제품에서 기본 제품을 설정합니다.
  6. API 제품 위젯에서 개발자가 API 제품을 선택하는 데 사용하는 HTML 요소를 선택합니다.
  7. 구성을 저장합니다.

콜백 URL 처리 구성

API 제품의 API 프록시가 'three-legged OAuth' (승인 코드 부여 유형)를 사용하는 경우 개발자는 앱을 등록할 때 콜백 URL을 지정해야 합니다. 콜백 URL은 일반적으로 클라이언트 앱을 대신하여 승인 코드를 수신하도록 지정된 앱의 URL을 지정합니다. 또한 이 URL 문자열은 유효성 검사에 사용됩니다. 클라이언트는 승인 코드 및 액세스 토큰을 요청할 때 이 URL을 Apigee Edge로 보내야 하며 redirect_uri 매개변수가 등록된 매개변수와 일치해야 합니다. 자세한 내용은 승인 코드 부여 유형 구현을 참고하세요.

API 제품 선택을 위한 콜백 URL을 제어하려면 다음 단계를 따르세요.

  1. 관리자 또는 콘텐츠 생성 권한이 있는 사용자로 포털에 로그인합니다.
  2. Drupal 관리 메뉴에서 Configuration > Dev Portal Settings > Application Attributes를 선택합니다.
  3. 애플리케이션 설정 페이지에서 콜백 URL 설정 영역을 펼칩니다.
  4. 콜백 URL 처리에서 다음 옵션 중 하나를 선택합니다.
    • 콜백 URL은 모든 개발자 앱에 필요합니다.
    • 콜백 URL은 모든 개발자 앱에서 선택사항입니다.
    • 콜백 URL이 필요하지도 표시되지도 않습니다.
  5. 구성을 저장합니다.

앱 사용에 대한 분석 표시

포털에는 앱 사용에 대한 분석 정보가 표시될 수 있습니다. 분석 표시를 사용 설정하면 앱 개발자가 각 앱의 내 앱 페이지에서 분석을 볼 수 있습니다. 예를 들어 개발자는 앱에 대해 다음과 같은 분석을 표시할 수 있습니다.

  • 처리량
  • 최대 응답 시간
  • 최소 응답 시간
  • 메시지 수
  • 오류 수

포털에서 분석을 사용 설정하려면 다음 안내를 따르세요.

  1. 관리자 또는 콘텐츠 생성 권한이 있는 사용자로 포털에 로그인합니다.
  2. Drupal 관리 메뉴에서 구성 > 개발자 포털 > 애플리케이션 설정을 선택합니다.
  3. 애플리케이션 설정 페이지에서 앱 성능 설정 영역을 펼칩니다.
  4. 개발자 앱 애널리틱스 탭 표시 체크박스를 선택합니다.
  5. 분석 데이터를 쿼리할 환경에서 테스트 또는 프로덕션을 선택합니다. 공개적으로 사용 가능한 포털의 경우 일반적으로 프로덕션을 선택합니다.
  6. 구성을 저장합니다.

앱 포털에 분석을 표시하려면 다음 단계를 따르세요.

  1. 내 앱 페이지에서 앱 이름을 선택합니다.
  2. 앱에 대한 애널리틱스 링크를 선택합니다.
  3. 표시할 분석의 유형과 기간을 선택합니다.
  4. 선택한 정보가 표시됩니다.

수동으로 API 제품의 API 키 승인 또는 취소

개발자가 앱에 API 제품을 추가한 후 앱을 등록하면 포털은 개발자에게 해당 앱의 API 키를 다시 반환합니다. 그런 다음 개발자는 해당 API 키를 사용하여 앱과 연결된 API 제품에 의해 번들된 API 프록시에 액세스합니다.

API 제품을 만들 때 각 API 제품에 대한 키 승인 프로세스를 제어할 수 있습니다.

승인 절차는 다음과 같습니다.

  • 자동 - 개발자가 앱을 등록하면 API 제품의 포털에서 승인된 API 키를 반환합니다. 나중에 자동으로 승인된 키를 취소할 수 있습니다.
  • 수동 - 개발자가 앱을 등록할 때 API 키가 포털에서 반환되지만 수동 키 승인을 사용하는 API 제품에 대해서는 키가 활성화되지 않습니다. 관리자가 API 키를 사용하여 API 제품에 액세스하려면 먼저 에지 관리 UI 또는 API에서 API 키를 수동으로 승인해야 합니다. 수동으로 승인된 키를 나중에 취소할 수 있습니다.

자세한 내용은 API 제품 만들기를 참조하세요.

포털에서 개발자가 여러 API 제품을 앱에 추가할 수 있는 경우 개발자는 자동 키 승인으로 일부 제품을 추가하고 수동 키 승인으로 제품을 추가할 수 있습니다. 개발자는 수동 승인이 필요한 제품의 최종 승인을 기다리는 동안 자동으로 승인된 모든 API 제품에 반환된 API 키를 즉시 사용할 수 있습니다.

앱의 API 제품 목록과 API 제품의 키 승인 상태를 보려면 개발자가 내 앱 페이지에서 앱 이름을 선택한 후 제품 링크를 선택합니다.

이 예시에서 Premium Weather API 제품은 수동 승인을 사용하며 관리자의 키 승인을 기다리고 있습니다. 무료 API 제품은 자동 승인을 사용하며 키 액세스를 위한 키 사용이 승인되었습니다.

키를 수동으로 승인하거나 취소하려면 다음 안내를 따르세요.

  1. 조직의 관리 권한이 있는 사용자로 에지 관리 UI에 로그인합니다.
  2. 오른쪽 상단의 드롭다운 상자에서 API 플랫폼을 선택합니다.
  3. 게시 > 개발자 앱을 선택하여 개발자 앱 목록을 엽니다.
  4. 대기 중 버튼을 선택하여 대기 중인 키 요청이 있는 앱 목록을 확인합니다.

  5. 승인하려는 앱 이름을 선택합니다.
  6. 앱 세부정보 페이지에서 오른쪽 상단에 있는 수정 버튼을 선택합니다.
  7. 앱의 API 제품 목록의 작업에서 다음을 수행합니다.
    • 키를 승인하려면 수동 승인이 필요한 각 API 제품에 대해 승인 버튼을 선택합니다.

    • 승인된 키를 취소하려면 API 제품의 작업 아래에서 취소 버튼을 선택하여 액세스 권한을 취소합니다.

  8. 앱을 저장합니다. 이제 API 키가 승인되었습니다.

API 제품 및 앱 캐싱 제어

API 제품 및 개발자 앱에 대한 정보는 Apigee Edge의 포털에서 원격으로 저장됩니다. 즉, 포털을 거치지 않고 Edge UI 또는 API에서 API 제품 및 앱을 변경할 수 있습니다. 예를 들어 백엔드 관리자가 새 API 제품을 추가할 때 포털이 해당 정보로 즉시 업데이트되지는 않습니다.

포털이 Edge 백엔드와 동기화 상태를 유지하도록 포털 캐시 업데이트를 수동으로 트리거하거나, 포털의 크론 작업이 실행될 때 캐시를 자동으로 업데이트하거나, 이 두 가지 방법을 모두 사용할 수 있습니다. 예를 들어 크론 작업이 자주 실행되도록(예: 5분 또는 10분마다) 구성할 경우 API 제품 및 개발자 앱 캐시를 자주 업데이트하는 오버헤드가 발생하지 않도록 해야 합니다. 이 경우 캐시 업데이트를 수동으로 트리거할 수 있습니다. 하지만 크론 작업이 1시간 또는 2시간마다 실행되는 경우 캐시를 업데이트하는 데 필요한 시간이 큰 영향을 미치지 않을 수 있습니다.

기본적으로 포털은 크론이 실행될 때마다 API 제품 및 개발자 앱 캐시를 다시 빌드하도록 구성됩니다.

크론이 실행될 때마다 API 제품 및 개발자 앱 캐시를 다시 빌드할지 여부를 지정하려면 다음 안내를 따르세요.

  1. 관리자 또는 콘텐츠 생성 권한이 있는 사용자로 포털에 로그인합니다.
  2. Drupal 메뉴에서 Configuration > Dev Portal Settings > Application Settings를 선택합니다.
  3. 크론이 실행될 때마다 API 제품 및 개발자 앱 캐시 다시 빌드를 선택하거나 선택 해제합니다.
  4. 설정을 저장합니다.

캐시를 수동으로 업데이트하려면 다음 안내를 따르세요.

  1. 관리자 또는 콘텐츠 생성 권한이 있는 사용자로 포털에 로그인합니다.
  2. Drupal 메뉴에서 홈 아이콘 > 모든 캐시 삭제를 선택합니다.

앱 등록에 사용되는 양식 필드 맞춤설정

개발자가 앱을 등록하면 포털에 기본 양식이 표시됩니다.

API 제공업체는 개발자에게 고객 ID, 앱의 타겟 플랫폼 또는 기타 정보와 같은 추가 정보를 제공하도록 이 양식을 수정하는 것이 좋습니다. 포털에서 이 양식에 새 입력란을 추가할 수 있습니다. 이러한 필드는 다음과 같습니다.

  • 필수 또는 선택사항
  • 텍스트 상자, 라디오 버튼, 체크박스 등의 다양한 HTML 요소로 표시됩니다.
  • 양식에서 콜백 URL 필드와 제품 필드 사이의 아무 곳에나 표시되도록 설정할 수 있습니다.

개발자 포털에서 제공되는 앱 등록 양식을 맞춤설정하는 방법을 알아보려면 이 동영상을 시청하세요.

예를 들어 다음 양식은 고객 ID의 필수 필드와 대상 플랫폼에 대한 선택적 필드를 보여줍니다.

양식에 새 필드를 추가하면 개발자가 양식을 제출할 때 필드 값이 다른 모든 필드와 함께 Edge에 자동으로 업로드됩니다. 즉, Edge에서 이러한 필드를 보거나 수정하거나 Edge 관리 API를 사용하여 스크립트에서 해당 필드에 액세스할 수 있습니다.

예를 들어 에지 관리 UI에서 게시 > 개발자 앱으로 이동한 다음 앱 이름을 선택하여 새 양식 입력란을 볼 수 있습니다. 새 필드 값이 페이지의 커스텀 속성 영역 아래에 필드의 내부 이름에 해당하는 이름으로 표시됩니다.

필드 값은 개발자의 내 앱 페이지에 있는 앱의 세부정보 영역에도 표시됩니다.

개발자는 내 앱 페이지에서 앱의 수정 링크를 선택하여 값을 수정할 수도 있습니다.

아래 절차에서는 관리자 인터페이스를 사용하여 앱 만들기 양식을 구성하는 방법을 설명합니다. Drupal 개발자는 커스텀 후크를 사용하여 '내 앱' 페이지 수정을 포함한 추가 맞춤설정을 실행할 수 있습니다. 코드를 통해 동작을 변경하는 방법을 자세히 알아보려면 파일의 앱 API 예를 참고하세요./profiles/apigee/modules/custom/devconnect/devconnect_developer_apps/devconnect_developer_apps.api.php

앱 등록 양식에 필드를 추가하려면 다음 안내를 따르세요.

  1. 관리자 또는 콘텐츠 생성 권한이 있는 사용자로 포털에 로그인합니다.
  2. DevConnect 앱 속성 관리 모듈이 사용 설정되어 있는지 확인합니다.
  3. Drupal 관리 메뉴에서 Configuration > Dev Portal Settings > Dev Portal App Attributes를 선택합니다.
  4. 페이지 상단에서 Add Dev Portal App Attribute(개발자 포털 앱 속성 추가) 버튼을 선택합니다.
  5. 필드를 구성합니다. 예를 들어 위에 표시된 고객 ID 필드의 경우 다음 설정을 사용합니다.
    • 내부 이름 = cust_id. 필드 값을 저장하는 데 사용되는 변수의 이름입니다.
    • 공개 이름 = 고객 ID
    • Description(설명) = 고객 ID를 입력합니다.
    • 이 속성 필요 체크박스를 선택합니다.
    • 이 속성 표시 체크박스를 선택합니다.
    • Widget = 텍스트 상자
    • 저장을 선택하여 Dev Portal 앱 속성 페이지로 돌아갑니다.
  6. 변경사항 저장을 선택합니다.
  7. Drupal 메뉴에서 Home icon > Flush all caches를 선택합니다.
    양식에 새 필드가 표시되려면 브라우저 캐시를 삭제해야 할 수 있습니다.

개발자가 앱의 플랫폼을 지정할 수 있는 선택적 필드를 추가하려면 필드 속성을 다음과 같이 설정합니다.

  • 내부 이름 = scheduled_platforms
  • 공개 이름 = 플랫폼
  • 설명 = 앱에 하나 이상의 플랫폼을 지정합니다.
  • 이 속성 필요 체크박스의 선택을 해제합니다.
  • 이 속성 표시 체크박스를 선택합니다.
  • Widget = 체크박스 목록
  • 저장을 선택하여 Dev Portal 앱 속성 페이지로 돌아갑니다.

양식의 속성을 재정렬하려면 다음 안내를 따르세요.

  1. 관리자 또는 콘텐츠 생성 권한이 있는 사용자로 포털에 로그인합니다.
  2. Drupal 관리 메뉴에서 Configuration > Dev Portal Settings > Dev Portal App Attributes를 선택합니다.
  3. Name(이름) 열에서 더하기(+) 기호를 선택하고 양식에 표시할 위치로 속성을 드래그합니다.
  4. 변경사항을 저장합니다.