개발자 포털(Developer Portal) 구축 방안

개발자 포털은 사용자가 표준화된 API를 사용하고 검색하고 사용할 수 있도록 다양한 API 관련 리소스가 포함된 디지털 목적지를 업계에 제공합니다. 포털은 개발자, 제품 관리자 및 전략가가 정보를 검색하고, API 카탈로그 및 문서에 액세스 하고, 테스트 샌드박스에 등록하여 API를 추가로 탐색할 수 있는 셀프서비스 플랫폼입니다. 목표는 사용자가 질문하고, 지원을 받고, 아이디어를 공유할 수 있는 협업을 가능하게 함으로써 솔루션에 대해 배우고 개발할 수 있는 도구를 통해 관련산업 및 개발자 커뮤니티를 돕는 것입니다.

개발자 포털 청사진 및 구성의 설계 원칙 (Design Principles)

• 다양한 사용자 유형에 맞는 사용성
• 사용자/개발자 유형 및 API 비즈니스 기능별 보안 및 권한 부여
• 읽기 쉬운 정보를 제공하는 최신 형식
• 사용자가 빠르게 탐색할 수 있는 단순화된 탐색
• 빠르게 변화하는 환경에서 사용자의 요구를 지원하는 대응성
• 검색 엔진 최적화
• 크로스 브라우저(Cross - browser) 호환성

 
개발자 포털 프레임워크의 주요 구성 요소
 

Technical Platform

개발자 포털은 Google의 Apigee Edge 등을 통한 API 관리 애플리케이션을 활용하는 셀프 서비스 플랫폼
 

Sandbox

프레임워크의 핵심 구성 요소에는 API를 시험하고 검증하기 위한 테스트 샌드박스가 포함됩니다. 테스트 샌드박스는 개발자가 사용할 수 있는 모든 API의 응답을 시뮬레이션하는 프로덕션 환경의 특성을 모방하는 데 사용할 수 있는 셀프 서비스 환경입니다.
 

• In-house에서 테스트하기 전에 비용 및 위험 감소
• 환경에 영향을 주지 않고 테스트 호출
• 오류 시나리오 시뮬레이션
• 빠른 개발 주기 및 시장 출시 시간 단축

 

사용자 엑세스 (User Access)

포털에 대한 액세스 모델은 정의된 사용자 프로필(익명 사용자, 기관 개발자, 공급자 개발자, 핀테크 개발자, 정부 기관 개발자 및 독립 개발자) 전반에 걸쳐 콘텐츠 및 개발 리소스에 대한 액세스를 보장하도록 설계되었습니다. 개발자 포털은 조직을 찾아보고 알아보고, 현재 구성원을 보고, 시작하는 방법을 이해하고, 조직에 연락할 수 있도록 모든 조직에 열려 있습니다. 테스트 샌드박스에 접속하고 활발한 포럼에 참여하고 지원을 받으려면 기본 등록(이름, 이메일, 회사 이름, URL, 개발자 유형, 주소)이 필요합니다.
 

운영 시스템 분석 (Operational Analytics)

개발자 포털은 애플리케이션 및 API의 사용을 측정하여 어떤 개발자가 참여하고 있고 어떤 API가 탐색 및 테스트되고 있는지 이해하는 비즈니스 인텔리전스 보고를 제공합니다. 이러한 메트릭은 업계에서 플랫폼 사용 및 API 채택이 증가함에 따라 커뮤니티를 효과적으로 업데이트하고 지원하기 위한 주요 운영 통찰력을 제공합니다.
 

API 카탈로그 및 설명서

포털은 사용자가 자신의 응용 프로그램에서 테스트를 위해 찾아보고 사용할 수 있는 개발을 위해 사용 가능하고 계획된 API에 대한 기본 정보와 설명을 제공합니다.
 

뉴스 및 포럼 

API 표준, 사용 사례 및 보안과 같은 주제에 대해 개발자 포털 사용자 간의 협업을 지원하는 최신 기사 및 정보를 포함하여 토론을 촉진하고 정보를 공유하는 데 도움이 되는 뉴스 및 포럼 구성 요소를 사용할 수 있습니다.
 

API 수명 주기 관리

개발자 포털은 API가 개발되는 시기, 새 API를 생성하는 시기와 기존 API를 리팩토링하는 시기, 백엔드 통합이 수행되는 방식을 관리하는 정책 및 절차를 준수합니다.
 

API 변경 관리 및 지원

API 및 API가 완료된 환경을 게시, 홍보 및 감독하고 API를 사용하는 앱 개발자에게 지원을 제공하는 접근 방식을 따릅니다.
 

 

반응형

 

 

그 밖에 개발자 포털의 진화 과정에서 추가로 고려할 수 있는 기능들
 

거버넌스 구조

거버넌스 프로세스는 플랫폼 사용에 따라 시간이 지남에 따라 형성될 기능 업데이트 및 변경 관리를 다루기 위해 정의되어야 합니다. API 표준 준수를 지원하기 위해 이해 관계자가 전략, 시장 관행 및 도구에 대해 조언할 수 있는 방법을 정의합니다. 투표 회원이 아이디어를 제공하고, 요구 사항의 우선순위를 지정하고, 변경 사항을 적용하고, 채택을 모니터링하고, 규정 준수를 보장하기 위한 정책 및 절차가 개발되고 있습니다.
 

포털의 부가 서비스 

개발자 커뮤니티를 지원하기 위해 포털은 코드 샘플과 같은 부가 가치 기능을 제공할 수 있습니다. 이니셔티브가 발전함에 따라 사용자 경험을 풍부하게 하기 위해 업데이트가 이루어지고, 사용자는 알림에 등록하여 API 표준화 산업 그룹의 새로운 소식, 출시되는 최신 API 및 포털 업데이트에 대해 알아볼 수 있습니다.
 

API 활성화 및 채택 추적

업계에 투명한 방식으로 사실에 기반한 정보를 제공하기 위해 은행과 제공업체의 준비 상태 및 API 사용을 공유하기 위한 등록 프로그램을 개발할 수 있습니다. 이를 통해 어떤 공급업체 제공업체가 API를 지원하고 있으며 어떤 은행이 API를 제품 포트폴리오(사업 영역, 시장 및 제품군 포함)의 일부로 제공하고 있는지에 대한 통찰력을 얻을 수 있습니다.
 

API의 지속적인 개발 및 우선순위 지정

초기 API 출시 및 추가 비즈니스 사용 사례를 지원하기 위한 API 개발에 대한 새로운 요청은 지속적으로 발생하게 되며, 이러한 업계의 요구에 따른 추가 API 개발을 위한 프로세스 수립이 필요합니다. 이는 표준 요청 및 우선순위 지정 프로세스의 따라 평가됩니다.
 

표준 API 유지보수 및 버전 관리

업계에서 일관된 사용을 보장하기 위해 개발자 포털을 통해 이 정보에 액세스하는 것을 포함하여 표준 및 버전에 대한 유지 관리를 처리하는 프로세스 개발을 할 수 있습니다. 이 프로세스는 리뷰 및 승인 주기가 있는 투표 프로세스를 기반으로 그룹 구성원과 공유되고 완료되면 개발자 포털에 게시됩니다.

 

By API Standardization Industry Group (ASIG), 2018

 

 

[참고] 금융권 API 표준화 관련 동향 관련 글:

 

전세계 금융권 API 표준화(Standardization) 동향