현재 Apigee Edge 문서가 표시되고 있습니다.
Apigee X 문서로 이동 정보
소셜 게시 기능이 있는 개발자 포털이 개발자 커뮤니티와의 커뮤니케이션을 위해 점점 더 많이 사용되고 있습니다. 여기에는 API 문서 및 이용약관과 같은 정적 콘텐츠와 블로그 및 포럼과 같은 커뮤니티 제공 동적 콘텐츠를 전달하는 것이 포함됩니다.
API 제공업체는 API를 노출하고, 개발자에게 API를 알리고, 개발자를 등록하고, 개발자가 앱을 등록할 수 있는 방법이 필요합니다. API를 개발자에게 노출하는 것은 진정한 동적 커뮤니티를 구축하는 과정의 일부일 뿐입니다. 또한 개발자 커뮤니티에서 의견을 제공하고, 지원 및 기능을 요청하며, 다른 개발자가 액세스할 수 있는 자체 콘텐츠를 제출할 방법이 필요합니다.
Apigee Edge는 맞춤설정된 웹사이트를 빌드하고 실행하는 데 사용할 수 있는 개발자 서비스 포털을 제공하여 개발 커뮤니티에 이러한 모든 서비스를 제공할 수 있습니다. 모든 Edge 고객은 클라우드 또는 온프렘에서 자체 개발자 포털을 만들 수 있습니다.
다음 동영상에서는 Apigee 개발자 서비스 포털을 소개합니다.
다음 그림은 기본 개발자 포털의 홈페이지를 보여줍니다.
개발자 포털은 본질적으로 오픈소스 Drupal (http://www.drupal.org) 프로젝트에 기반을 둔 콘텐츠 관리 시스템 (CMS)입니다. Drupal은 핵심 기능 세트를 모듈 형식으로 제공합니다. 이를 통해 웹사이트의 콘텐츠를 쉽게 빌드하고 관리할 수 있습니다.
개발자 포털을 통해 즉시 API 문서를 만들고 블로깅을 지원하며 스레드 포럼을 제공할 수 있습니다. 특정 요구사항을 충족하도록 개발자 포털을 맞춤설정할 수도 있습니다. 맞춤설정을 통해 포털 모양은 물론 개발자가 포털과 상호작용하는 방식도 수정할 수 있습니다.
대부분의 맞춤설정은 Drupal 메뉴를 사용하여 실행합니다. 관리자 권한이 있는 사용자로 포털에 로그인하면 모든 포털 페이지 상단에 Drupal 메뉴가 표시됩니다.
관리는 개발자가 포털에 대한 액세스를 요청하는 프로세스, 개발자가 API에 액세스하는 앱을 등록하는 방법, 개발자에게 API와 관련된 특정 역할 및 권한을 할당하는 방법, API에 대한 개발자의 액세스 권한을 취소할 시기를 제어합니다.
또한 개발자 포털을 사용하여 수익 창출을 구성하고 관리할 수도 있습니다. 수익 창출은 개발자가 개발자 포털을 통해 청구 및 보고서, 카탈로그 및 요금제, 수익 창출별 설정에 셀프서비스로 액세스할 수 있는 권한을 부여합니다.
포털 사용자 유형
다음 이미지는 두 가지 유형의 포털 사용자를 보여줍니다.
- 개발자는 API를 사용하여 앱을 빌드하는 사용자 커뮤니티를 구성합니다. 앱 개발자는 포털을 사용하여 SmartDocs를 통해 API에 대해 알아보고, 포털에 계정을 등록하고, API를 사용하는 앱을 등록하고, 개발자 커뮤니티와 상호작용하고, 대시보드에서 앱 사용에 대한 통계 정보를 볼 수 있습니다.
-
API팀은 포털 콘텐츠를 만들고, 앱 개발자에게 API를 제공하고, API 문서를 제공하고, 개발자가 앱을 등록하고 API 키를 얻을 수 있는 메커니즘을 제공하는 API 제공업체입니다. API팀은 개발자 포털의 기본 구성을 수행하여 다음을 수행합니다.
- API 키의 자동 또는 수동 요청 구성
- API 문서, 포럼, 블로그를 유지관리하고 필요한 경우 모든 변경사항을 수정합니다.
- 사용자 댓글 및 포럼 검토 처리
- 역할 기반 액세스 제어 (RBAC)를 적용하여 포털의 기능에 대한 액세스를 제어합니다. 예를 들어 관리자는 등록된 사용자가 포럼 게시물을 만들거나 테스트 콘솔을 사용하도록 허용하는 컨트롤을 사용 설정할 수 있습니다.
- 사용자 생성 및 승인을 위해 관리자와 개발자 모두를 대상으로 이메일 알림을 맞춤설정합니다.
- '문의하기' 페이지와 같은 웹 양식 맞춤설정
이 그림에는 세 번째 포털 사용자 유형인 API 제품 관리자가 나와 있지 않습니다. API 제품 관리자는 API팀이 포털을 빌드하는 방법을 정의하며, 여기에는 다음이 포함됩니다.
- API를 제품으로 패키징하는 방법 정의
- 앱 승인 규칙 정의
- 포털에서 수익 창출이 사용 설정된 경우 API 제품의 가격 책정 및 결제 요금제를 정의합니다. 수익 창출에 대한 자세한 내용은 수익 창출 개요를 참고하세요.
개발자 포털 맞춤설정
API 제공업체는 API에 가장 적합하게 개발자 포털을 맞춤설정하는 방법과 개발자 커뮤니티에서 API를 사용하는 데 필요한 정보를 제공하는 방법을 고려해 보세요. 커스텀 포털과 관련된 몇 가지 고려사항은 다음과 같습니다.
- 간편한 API 액세스
- 문서(예: 안내 가이드 및 참조 문서)
- 블로그, 토론 포럼 등 커뮤니티 제공 콘텐츠
- 샘플 코드
- 신규 개발자, 앱, API를 빠르게 승인할 수 있는 간편한 가입 절차
- 관리되는 권한 및 사용자 인증 정보
- 단계식 액세스 제어
- 조직에 맞는 디자인
포털은 기본 구성으로 사전 정의된 상태로 제공됩니다. 예를 들어 기본적으로 포털은 누구나 개발자로 등록할 수 있도록 구성되어 있지만 각 등록을 관리자가 승인해야 개발자가 포털에 로그인할 수 있습니다. 등록이 승인된 후 개발자는 앱을 등록하여 API 키를 요청하고 포털을 사용하여 API 리소스에 액세스할 수 있습니다.
기본 등록 절차는 다음과 같습니다.
- 개발자는 개발자 포털을 통해 등록합니다. 이에 따라 포털에서 관리자에게 계정을 승인하라는 이메일을 보냅니다.
- 관리자가 계정을 승인하면 개발자에게 이제 로그인할 수 있음을 알리는 이메일이 전송됩니다.
- 개발자가 앱을 등록하고 앱에서 사용하는 API 제품을 선택합니다. 이에 대한 응답으로 포털은 앱에 고유한 API 키를 할당합니다.
- 개발자는 API에 요청할 때 API 키를 전달합니다.
이러한 즉시 사용 가능한 환경은 고도로 맞춤설정할 수 있습니다. 예를 들어 기본 등록 및 승인 체계를 재정의하여 새 개발자가 등록 후 자동으로 승인되고 로그인되도록 할 수 있습니다. 또는 개발자에게 처음으로 로그인하기 전에 이용약관에 동의하도록 요구할 수 있습니다.
또한 개발자 포털에서 제공되는 콘텐츠를 완벽하게 제어할 수 있습니다. 개발자 포털은 즉시 사용 가능한 API 문서, 블로그 게시물, 포럼 토론 등의 샘플 콘텐츠를 제공합니다. 자체 콘텐츠를 제공하고 각 콘텐츠 유형의 모양을 맞춤설정할 수 있습니다.
자세한 내용은 모양 맞춤설정을 참고하세요.
개발자 포털 관리
개발자는 개발자 포털을 사용하여 API에 액세스하고 사용합니다. 관리자는 다음과 같은 계정 관리 작업을 수행합니다.
- 등록 필드, 기본 제공 보안문자, 자동 또는 수동 승인 등 개발자 등록 프로세스 맞춤설정
- 개발자 추가 또는 승인 기본적으로 모든 개발자는 개발자 포털을 통해 등록할 수 있지만 개발자 포털 사용자 인터페이스를 통해 관리자의 승인을 받아야 합니다. 관리자는 포털에서 직접 개발자를 만들 수도 있습니다. 그러면 포털에서 자동으로 개발자에게 계정이 생성되었음을 알리는 이메일을 보냅니다.
- 개발자 계정 수정 예를 들어 관리자는 사용자의 계정 상태를 활성에서 차단됨으로 변경하거나 회사 이름과 같은 개발자 프로필 정보를 변경할 수 있습니다.
- 개발자 삭제 관리자는 개발자 계정을 사용 중지하거나 삭제할 수 있습니다.
- 역할 및 권한 할당: 관리자는 개발자 계정에 특정 역할을 할당할 수 있습니다. 역할은 도서 또는 기타 콘텐츠를 만들 수 있는 권한과 같은 다양한 권한과 연결됩니다. 역할과 연결된 권한을 변경하거나 새 역할을 만들 수도 있습니다.
자세한 내용은 사용자 계정 추가 및 관리를 참조하세요.
개발자 포털 기능 요약
다음 표에는 개발자 포털 기능이 요약되어 있습니다.
| 기능 | 세부정보 |
|---|---|
| 브라우저 지원 |
지원되는 소프트웨어 및 지원되는 버전을 참조하세요. |
|
사용자 등록 |
|
|
사용자 관리 |
|
|
포털 모양 |
|
|
콘텐츠 및 커뮤니티 관리 |
|
|
권한 |
|
|
API 키 관리 |
|
|
이메일 |
|
|
블로그 |
|
|
포럼 |
|
|
문서 |
|
|
메뉴 |
|
|
검색 |
|
|
링크 검사 프로그램 |
|