Tech story/Cloud

kt cloud 파트너사를 위한 전용 API 쉽게 사용하기(feat.파트너 포털)

kt cloud 테크블로그 2024. 10. 14. 15:07

[kt cloud Cloud채널강화팀 권재한 님]

 

kt cloud 파트너사를 위한 전용 API 쉽게 사용하기(feat.파트너 포털)

 

다양한 Cloud사업자(CSP)는 자사의 Cloud 서비스를 고객과 파트너사들이 쉽게 이용하기 위해 다양한 형태의 접근 방식을 제공합니다. 가장 기본적으로 콘솔(Console)을 제공하고 있지만 개발자나 엔지니어에 친화적으로 API와 SDK와 같은 형태의 서비스도 함께 제공합니다. 그 중에서도 많이 이용되는 방식은 API 입니다. 그럼 API란 무엇인지 먼저 개념을 알아볼까요?

API [Application Programming Interface]
 
[요약] 운영체제와 응용프로그램 사이의 통신에 사용되는 언어나 메시지 형식을 말한다.


운영체제나 C, C++, Pascal 등과 같은 언어로 응용 프로그램을 만들 때, 윈도우를 만들고 파일을 여는 것과 같은 처리를 할 수 있도록 1,000여 개 이상의 함수로 구성되어 있다. API는 프로그래머를 위한 운영체제나 프로그램의 인터페이스로서 사용자와 직접 대하게 되는 그래픽 사용자 인터페이스나 명령형 인터페이스와 뚜렷한 차이가 있다.
API는 응용 프로그램이 운영체제나 데이터베이스 관리 시스템과 같은 시스템 프로그램과 통신할 때 사용되는 언어나 메시지 형식을 가지며, API는 프로그램 내에서 실행을 위해 특정 서브루틴에 연결을 제공하는 함수를 호출하는 것으로 구현된다. 그러므로 하나의 API는 함수의 호출에 의해 요청되는 작업을 수행하기 위해 이미 존재하거나 또는 연결되어야 하는 몇 개의 프로그램 모듈이나 루틴을 가진다.

 

이러한 API를 Cloud에서 이용하면 고객이나 파트너사가 반복적인 작업이나 연속된 작업, 콘솔에 접속하지 않고도 손쉽게 작업을 수행할 수 있습니다.

 

<API를 통해 가능한 기본 업무 내역>

  • 계정 생성
  • 요금 조회
  • VM, Disk, Loadbalancer, Snapshot 등 세부 서비스 생성, 변경, 삭제 등의 업무
  • 서비스 모니터링 등 Cloud 서비스 운영 관리 업무 등

 

kt cloud에서는 크게 2가지 유형의 API를 제공합니다.

 

누구에게나 공개된 “Open API”

 

첫번째는 누구에게나 공개된 “Open API” 입니다. Open API는 kt cloud 홈페이지(cloud.kt.com) 내 [고객지원 - Open API 가이드] 메뉴에서 아래와 같이 참고하실 수 있습니다.

 

kt cloud - Open API Guide

kt cloud 의 @D Platform 에서 사용 가능한 Open API 가이드 문서입니다. 본 페이지에서는 Open API 호출을 위한 기본 준비 사항를 예제와 함께 안내해드립니다. 1. kt cloud 의 Open API 는 RESTful API 방식으로 제

cloud.kt.com

 

<Open API 가이드>

 

대부분의 API가 동일하지만 Open API를 이용하기 위해서는 API Key가 필요한데, G1/G2 플랫폼에서는 API Key와 Secret Key를, DX-M1 플랫폼에서는 Token 발급을 통해 이용하실 수 있습니다.

 

<G1/G2플랫폼에서 Open API를 이용하기 위한 API Key 발급>

 

<DX-M1플랫폼에서 Open API를 이용하기 위한 Token 발급>

 

참고로 Open API 활용법은 Platinum 파트너사인 디딤365에서 예시로 제공하고 있으니 참고하시기 바랍니다.

KT ucloud biz Open API 테스트 - API 테스트 사이트 만들기

 

파트너사를 위한  Reseller API 

 

두 번째 API는 “Reseller API” 입니다. Reseller API는 말 그대로 재판매를 할 때 사용하는 API로써, kt cloud의 재판매 파트너(총판)만을 위한 API라고 할 수 있습니다. 특정 업체를 위해서만 제공 되는 API다보니 인증된 파트너사에만 공개가 됩니다. 인증 받은 파트너사의 경우 인증된 Cloud 계정으로 로그인을 하면 다음과 같이 Reseller API 가이드를 확인할 수 있습니다.

<Reseller API 이용 가이드>

 

Reseller API가 필요한 이유를 알기 위해서는 kt cloud 재판매 구조와 일반적인 계약의 차이점을 이해해야 합니다. kt cloud 재판매는 파트너사(a.k.a. 총판 파트너)를 통해 이루어지며, 이때 kt cloud 상품에 대해 파트너 등급에 따라 할인율을 제공하고 있습니다. CSP인 kt cloud로부터 제공받은 할인된 가격에 재판매 마진을 붙이고, 파트너사의 Managed 서비스나, 3rd Party 솔루션 등을 함께 결합하여 고객사에게 공급하는 역할을 합니다. 그렇기 때문에 kt cloud의 파트너사는 영업 뿐만 아니라 기술, 운영 역량까지 갖추어 통합적으로 고객 Care가 가능한 경우 파트너사가 될 수 있습니다.

 

<kt cloud 총판 파트너(재판매 방식) 계약 형태>

이러한 계약 형태로 되어 있다보니 중간 역할을 하는 파트너사에서는 다수의 Cloud 계정을 생성하고, 월별 이용 명세서 작성, 마진을 반영한 요금 청구 작업이 매월 발생합니다. 이를 원활히 하기 위해 파트너사에서 이용할 수 있는 특화된 API가 바로 “Reseller API” 입니다.

 

<Reseller API를 이용한 계정 생성 구조> Open image-20240927-013552.png

 

<일반 가입과 파트너사를 통한 가입시 단가 차이>

 

앞서 Open API를 이용하려면 API/Secret Key 또는 Token 발급이 필요한데 반해 Reseller API는 Reseller Key가 필요합니다. Reseller Key를 발급 받기 위해서는 kt cloud의 공식 파트너 협정이 체결된 이후 파트너사의 Admin 계정이 있어야 합니다. 아래와 같이 kt cloud에서 파트너사가 이용할 공식 Admin 계정을 가입하고, 아래와 같은 파트너사의 정보를 전달하면 kt cloud 내부적으로 해당 계정을 Admin 계정으로 처리합니다. 이후에 20자리 난수 형태의 Reseller Key가 발급이 됩니다.

kt cloud 가입 계정 ktcloud_partner@ooo.co.kr
사업자번호 247-81-xxxxx
법인번호 110111-xxxxxxx
대표자명 OOO
공지수신 이메일 ktcloud_partner@ooo.co.kr
전화번호(회사대표번호) 02-xxxx-xxxx
사업자등록증 첨부참조

본격적으로 Reseller API 이용 방법을 알아보겠습니다. Reseller API를 이용하려면 Cloud Zone 별로 API END POINT를 확인하고, 필요한 Command, Parameter를 기재하면 됩니다.

 

그 중에서도 파트너사에서 가장 많이 이용하는 Reseller API는 특정 계정의 월별 상세 요금 조회하는 기능입니다. 월별 상세 요금을 조회하는 API 호출 예시는 다음과 같습니다. [Cloud Zone 별 API-END-POINT + Reseller Key + Command + 계정명 + 검색일자 + 요금 검색 방식(Parameter)] 형태로 구성이 되는데 이때 유의사항은 계정명 같은 곳에 “@”와 같은 문자는 “%40” 치환을 해서 호출을 해야 한다는 점만 유의하시면 되겠습니다.

 

<Reseller API를 이용한 특정 계정 요금 조회>

 

하지만 신규 파트너사거나, 내부 개발자분이 계시지 않다면 간단한 API도 사용하기 어려워하는 곳이 많습니다. 구조를 이해했더라도 API 호출을 웹브라우저로 호출하게 되면 아래와 같이 XML 형태로 출력되어 실제 청구서나 명세서 작업에 활용도가 떨어집니다.

 

<Reseller API를 Edge 브라우저에서 호출시 결과물 예시>

 

이에 파트너사에서 개발자 없이 좀 더 쉽게 API를 이용하기 위해서는 Microsoft Excel을 이용하는 방법이 있습니다. Excel에서는 다양한 형태의 외부 데이터를 가져올 수 있는 파워풀한 기능이 있습니다.

  • Excel 실행 > 데이터 > 웹 선택

  • API 호출 URL 입력 후 “확인” 클릭 > “여러 항목 선택” 체크 후 하단 체크 박스 모두 체크 후 “다음으로 로드”

 

  • “데이터 가져오기” 창에서 “표”, “새 워크시트” 선택 후 “확인” 버튼 클릭

 

  • 결과물 확인 : 서비스별 월 청구요금, 할인된 요금 내역, 세부 Cloud 자원별(VM, Disk 등) 표준 요금, 자원명, 스펙 정보, 생성/삭제일 확인 가능

<서비스별 청구요금, 할인 요금>
<세부 자원명, 자원스펙, 표준요금, 생성/삭제일 정보>

 

보시다시피 앞서 보신 XML 형태로 결과물보다 익숙한 Excel 파일이라 훨씬 편리하다는 점을 알 수 있습니다. 이를 좀 더 발전 시키면 Billing/청구서 생성, Open API와 결합하여 통합 CMP(Cloud Management Platform)로 개발 가능합니다. 실제로 많은 kt cloud의 파트너사들이 이러한 API를 이용하여 자사의 CMP 솔루션을 개발하여 운영하고 있습니다.

 

구분 디딤365 웰데이타시스템(엔클라우드24) 메가존클라우드
CMP DidimNow(디딤나우) OpsaaS(옵스어스) HyperBilling for kt cloud
(하이퍼빌링 for kt cloud)
 

만약 CMP 개발까지 추진하기엔 아직 규모도 작고, 사업 건도 작은 파트너사라면 한계를 느낄 수 밖에 없습니다. 하지만 실망하지 마세요! kt cloud는 파트너 포털을 통해 더 쉽게 이러한 요금 정보 등을 확인할 수 있도록 제공하고 있습니다.

<파트너 포털 대시보드 예시>

 

kt cloud의 파트너 포털은 kt cloud 재판매를 하는 파트너사들이 실제 Cloud 자원과 빌링 내역, 청구서, 세금계산서까지 이어지는 일련의 행정 절차 뿐만 아니라 파트너사가 재판매시 필요로 하는 다양한 자료 제공, 공지사항을 확인할 수 있는 시스템입니다. '24년 9월에 오픈한 kt cloud의 파트너 포탈은 파트너사 입장에서 매입/매출 관리시 활용도가 높아 업무 부담을 줄여주고, 언제든지 자료 확인이 가능함에 따라 보다 빠르게 사업을 추진할 수 있도록 지원합니다.

<파트너사 고객별 매입 정보 내역 예시>

 

앞서 설명드렸던 Reseller API를 통한 요금 조회(Command : listCharges)를 파트너 포털 내에서는 클릭 몇 번만으로 확인이 가능합니다.

<개별 계약 건별 세부 서비스 내역 및 요금 조회 예시>

 

마무리

파트너 포털은 위 예시와 같이 이용요금 조회의 편리함 뿐만 아니라 파트너사 입장에서 다양한 도입 이점이 있으며, 지속적으로 고도화하여 운영할 예정입니다.

 


구분
파트너 포털 도입 이전 파트너 포털 도입 이후 Bnefit
파트너
컨텍포인트 관리
  • 파트너사 내 여러 담당자 정보 및 연락처 현행화의 어려움
  • 등급유지 조건(기술/영업)인력을 충족하기 위해 직접 이직/퇴사/입사 등에 대해 Self서비스로 현행화 가능
자료 관리
  • 파트너사에게 필요한 자료 제공의 어려움 (메일로만 제공)
  • 세일즈/기술/디지털서비스전문계약제도/Cloud성능점검/CSAP인증서 등 파트너사가 사업 추진을 위해 필요한 자료를 쉽게 확인 가능
공지사항/행사 등 안내
  • 공지/프로모션/행사/작업협조 등 메일/유선만으로 소통의 어려움
  • 공지사항, 자료실을 통한 소통으로 이력 관리 가능
파트너 계정/
고객관리
  • 파트너 등급 할인율을 받고 있는 파트너 계정 전체 리스트를 확인하기 번거로움
  • 파트너사 : 개별 엑셀로 관리 (일부 파트너사만 CMP 구축하여 이용)
  • 관리 고객 전체 리스트를 실시간으로 확인 가능
  • 매입가, 할인내역 확인 가능
파트너 협정 관리
  • 파트너 협정 신청, 검토중, 체결 완료, 종료 단계별로 수작업 관리로 이력관리의 어려움
  • 신청단계/승인단계/등급현황/재판매 협정서를 상시 확인가능 (문의 감소)
할인 내역 관리
  • 파트너사에서 매입정보, 등급할인, 쿠폰 할인, 전략할인에 대한 상세내역 확인하기 어려움
  • Reseller API를 이용해서 할인 내역 일부 확인 가능
  • kt cloud 내부 영업전산 시스템과 연동으로 정확한 매입 금액 확인 가능
  • Reseller API를 이용하지 못하는 파트너사도 상세 할인 내역 확인 가능

파트너사와 동반 성장하는 kt cloud! 앞으로도 많은 관심 부탁드립니다!

 

출처/참고

kt cloud 홈페이지(cloud.kt.com),

API 개념 - 네이버 백과사전(네이버 )