Our Story
home
위베어소프트
home

OSORI APIM v3.0 매뉴얼

저작권

※ 본 제품의 저작권은 「㈜위베어소프트」에 있으며, 본 소프트웨어 및 제품설명서, 매뉴얼의 일부 또는 전부를 무단복제, 사용할 수 없습니다.
※ 본 제품에서 제공되는 모든 콘텐츠 즉, 이미지, DB정보 등은 저작권법에 의하여 보호받는 저작물로 별도 저작권 표시 또는 출처를 명시하지 않는 경우를 제외하고는 원칙적으로 「㈜위베어소프트」에 저작권이 있습니다.
※ 「OSORI APIM v3.0」의 자료 및 UI를 무단 복제, 배포하는 경우에는 저작권법 제136조 제1항 제1호 위반에 해당 되면 관련 법규에 의해 처벌 받을 수 있습니다.
개발 및 공급회사 : 주식회사 위베어소프트
주소 : 서울특별시 강남구 봉은사로 435, KTOA 509호
Tel. : 070-4467-8339
Website : https://www.webaresoft.com

개정이력

개정번호
재개정일자
재개정 내용
작성자
1.0
2023.10.30
최초작성
구모정
1.1
2023.11.01
정책추가
이연주
1.2
2023.11.06
개요정보 수정
장영휘
1.3
2023.11.07
설치정보 수정
김용혁

제품 개요

제품 정보 및 공급자 정보

제품명
OSORI APIM
버전
v3.0
구성요소
• API Manager/Portal Web-UI v3.0 • Admin 서버 (Data 저장) v3.0 • API Gateway 서버 v3.0
정보
API 관리 및 중개 시스템으로 API 개발자, 사용자를 위한 제품
출시일
2023.11.01.
제조 및 공급업체
㈜위베어소프트
제조 및 공급업체 주소
서울특별시 강남구 봉은사로 435, KTOA 509호 Web : https://www.webaresoft.com Tel. 070-4467-8339
※ OSORI APIM v3.0에 적용된 표준, 규격 및 법령이 존재하지 않음.

제품 개요 및 용도

본 제품은 API(Application Programming Interface, 이하 API)를 관리(등록하고 중개처리)할 수 있도록 지원하는 소프트웨어입니다.
위베어소프트의 OSORI APIM은 API 연계를 위한 API Gateway와 API 관리를 위한 API Manager, 그리고 API 공개를 위한 API Portal을 제공합니다.
OSORI APIM은 클라우드 환경 및 온프레미스, 하이브리드 환경을 지원하며 OAS(Open API Specification, swagger)를 표준 API로 지원합니다. 모든 구성 요소 간 통신은 암호화 통신을 합니다.
OSORI APIM을 통해 API 관리 및 연계 작업들을 쉽고, 안정되게 진행할 수 있습니다. 이를 통해 고객은 보다 효율적으로 비즈니스에 집중할 수 있습니다.

제품 구성 요소 소개

API Gateway
외산 제품이 아닌, 자체 개발 API Gateway Engine 입니다. GC(Garbage Collection)가 없고, 고성능 고효율 언어인 Rust 언어로 개발 되었습니다. Event driven multi thread 구성으로 API 요청을 효율적으로 처리합니다.
보안/인증,인가 처리: API-Key, SSL/TLS
API 라우팅: HTTP, 로드 밸런싱, 서킷 브레이커
데이터 수집: 요청/응답 처리 정보, 시스템 리소스 정보
API Manager
UI 기반으로 API의 Life-Cycle을 관리합니다. API 요청 처리를 위한 API Gateway를 UI에서 클러스터 단위로 손쉽게 관리합니다. 통계 정보를 통해 API의 사용량을 모니터링 합니다.
API 관리: 상품별 API, 리소스, 스테이지(버전), Swagger
시스템 관리: API Gateway 클러스터, 상태, 제어
통계: 상품/API, 스테이지
API Portal
API를 사용하고자 하는 APP 개발자에게 상품 단위의 API를 공개(게시) 합니다. APP 개발자는 어플리케이션을 생성하여 API-Key를 발급받고, 사용하고자 하는 상품에 대해 구독하고 승인을 얻은 후 API를 사용합니다. 상품별로 통계 정보를 확인하여 모니터링하고, 커뮤니티를 통해 서로 소통합니다.
Admin Server
API Gateway, API Manager, API Portal의 정보를 관리하는 중앙 서버 입니다.

제품 운영 환경 및 구성

최소 운영 환경
구분
HW/SW
항목
사양
API Manager/ Portal Web-UI v3.0
HW
CPU
Intel Dual Core 2.4 GHz
RAM
2 GB
HDD
20 GB
NIC
10/100/1000 Mbps 1 EA Port
SW
OS
Linux 64bit - CentOS 7.9, Ubuntu 20.04
Web Server
Nginx 1.20.0, Nginx latest
Admin 서버 v3.0
HW
CPU
Intel Dual Core 2.4 GHz
RAM
2 GB
HDD
20 GB
NIC
10/100/1000 Mbps 1 EA Port
SW
OS
Linux 64bit - CentOS 7.9, Ubuntu 20.04
DBMS
PostgreSQL latest, Docker latest Image
API Gateway 서버 v3.0
HW
CPU
Intel Dual Core 2.4 GHz
RAM
2 GB
HDD
20 GB
NIC
10/100/1000 Mbps 1 EA Port
SW
OS
Linux 64bit - CentOS 7.9, Ubuntu 20.04
※ 모든 구성 제품 운영 - Linux 64bit Docker 환경 기반
※ Docker Hub Repository - webaresoft
서버 기동 방법
Admin 서버 v3.0 실행 명령 예시
sudo docker pull webaresoft/osori-admin:3.0.0 sudo docker run -d --name osori-admin \ -p 5580:5580 -p 5581:5581 -p 5583:5583 \ -e DOMAIN_ADDRESS=www.google.com:443 \ -e DB_HOST=127.0.0.1 \ -e DB_PORT=5432 \ -e DB_USERNAME=postgres \ -e DB_PASSWORD=123456 \ -e DB_DATABASE=osori \ webaresoft/osori-admin:3.0.0
Shell
복사
포트 포워드
5580: API Manager(API 개발자, 관리자)와 통신하는 포트
UI의 UI_ADMIN_ADDR 포트와 일치해야 함
5581: API Gateway(엔진)와 통신하는 포트
API Gateway의 ADMIN_ADDR 포트와 일치해야 함
5583: API Portal(사용자)과 통신하는 포트
환경 변수
DOMAIN_ADDRESS: API Gateway가 운영될 서버의 주소
DB_HOST: PostgreSQL IP
DB_PORT: PostgreSQL Port
DB_USERNAME: PostgreSQL 사용자
Postgres의 POSTGRES_USER와 일치해야 함
DB_PASSWORD: PostgreSQL 패스워드
Postgres의 POSTGRES_PASSWORD와 일치해야 함
DB_DATABASE: Postgres 데이터베이스 명
Postgres의 POSTGRES_DB와 일치해야 함
DB - PostgreSQL 실행 명령 예시
sudo docker run -d --name postgres \ -p 5432:5432 \ -e POSTGRES_USER=postgres \ -e POSTGRES_PASSWORD=123456 \ -e POSTGRES_DB=osori \ postgres
Shell
복사
포트 포워드
5432: PostgreSQL DB에 접속하기 위한 포트
환경 변수
POSTGRES_USER: 사용자
POSTGRES_PASSWORD: 패스워드
POSTGRES_DB: 데이터베이스 명
API Manager/Portal Web-UI 서버 v3.0 실행 명령 예시
sudo docker pull webaresoft/osori-ui:3.0.0 sudo docker run -d --name osori-ui \ -p 5585:5585 \ -e UI_ADMIN_ADDR=127.0.0.1:5580 \ webaresoft/osori-ui:3.0.0
Shell
복사
포트 포워드
5585: 브라우저에서 Web-UI에 접속하기 위한 포트
환경 변수
UI_ADMIN_ADDR: Admin 서버와 통하기 위한 IP:Port 정보
Admin 서버 실행 정보와 일치해야 함
API Gateway 서버 v3.0 실행 명령 예시
sudo docker pull webaresoft/osori-gateway:3.0.0 sudo docker run -d --name osori-gateway \ -p 5582:5582 \ -e ADMIN_ADDR=127.0.0.1:5581 \ webaresoft/osori-gateway:3.0.0
Shell
복사
포트 포워드
5582: API Client로부터 API Gateway에 요청하기 위한 포트
환경 변수
ADMIN_ADDR: Admin 서버와 통하기 위한 IP:Port 정보
Admin 서버 실행 정보와 일치해야 함

제품의 이점

보안, 성능, 효율, 안정성을 강조한 API Gateway
API Gateway는 고성능, 고효율, 안정성 및 보안을 중시하여 최신 프로그램 언어인 RUST로 개발 되었습니다.
유연하고 안정적인 API 관리
Open API 스펙에 맞춰 REST API 및 이와 관련된 리소스와 메서드를 정의하고, 스테이지 생성을 통하여 같은 API를 여러 버전으로 관리하고 실시간으로 배포하거나 취소할 수 있습니다.
구독 관리를 통한 사용자 인증
API Manager를 통해 배포된 API는 API Key를 통해 보호됩니다. API를 사용하기 위해서는 API Portal에서 어플리케이션 생성을 통해 API-Key를 발급 받고, 구독 요청을 통해 승인을 얻어야 합니다.
클러스터 및 UI를 통한 API Gateway 관리
UI를 통해 API Gateway를 클러스터 단위로 설정하고 관리할 수 있습니다. API 배포 시 클러스터 된 API Gateway를 선택하여 배포할 수 있습니다.

제품의 제한사항

본 솔루션의 Web-UI는 (API Portal의 상품의 기본정보 조회를 제외하고) 관리자 정보 및 사용자 정보관리를 통해 접근이 가능하며, 권한이 없는 경우 사용 할 수 없도록 접근이 제한됩니다.
API Manager의 모든 메뉴에 접근 및 사용 가능한 최상위 관리자 ID를 초기 설치 시에 1개만 생성 및 제공됩니다.
API Manager의 최상위 관리자는 모든 리소스 접근이 가능하며, 최상위 관리자는 삭제 또는 탈퇴할 수 없습니다. 최상위 관리자는 관리자 및 개발자를 추가할 수 있습니다. 개발자는 시스템, 회원관리, 게시관리, 포탈관리, 설정 등의 관리자 메뉴에 대한 접근 및 사용이 불가능합니다.
본 솔루션의 사용자 유형은 최상위 관리자, 관리자, 개발자 및 일반회원(API 포탈 사용자)로 분류됩니다.
일반회원(API 포탈 사용자)의 경우 API Portal에서 회원가입이 이뤄진 후에 API Portal의 모든 메뉴에 대해 접근 및 서비스 이용이 가능하며 비회원 이용 시 제한된 (상품만 조회 가능)형태로 서비스 이용이 가능해집니다.
본 솔루션은 사용자의 입력 필드에 대한 입력 값 제한 기능이 존재하며, 사용자가 잘못 입력한 데이터에 대해 자동 점검 기능을 제공합니다.
API Manager V3.0 및 API Portal V3.0은 로그인 후 사용자 요청이 10분 동안 없을 경우 자동으로 해당 사용자의 로그아웃이 이루어진 후 초기 로그인 화면으로 이동합니다.

제품의 온라인 도움말 및 튜토리얼

https://www.webaresoft.com/service/guide

제품 사용 가이드

메뉴 구성

No.
대분류
중분류
소분류
메뉴 설명
1
로그인
로그인
로그인
ID, PW 사용한 사용자 인증
2
회원가입
회원가입
회원가입
ID, PW 정보입력을 통한 회원가입
3
개발자 신청
개발자 신청
개발자 신청
API 개발자 권한 획득 신청
4
상품
상품 목록 및 상세정보
게시된 상품 목록 및 상세정보
검색, 상품 정보, 게시자 정보, 요금제 정보 등 확인
5
구독 신청
요금제 목록 확인, 요금제선택
상품의 요금제 선택 및 구독 신청
6
유저 계정 관리  
계정 관리
계정 정보 수정
비밀번호 등 정보 수정
7
구독 상품 정보
구독 상품 목록 및 상세정보
상품별 이용 정보, 사용현황, 스펙문서 다운로드 등
8
구독 신청 내역
구독 신청 내역
신청 내역 확인, 구독 취소
9
상품 관리                
상품 관리
상품 생성/수정/삭제
상품/담당자 정보, 요금제 매핑
10
상품 목록 및 상세정보
생성된 상품 정보, 게시 상태 확인
검색, 게시 요청, 보유 API 확인 등
11
API 관리
API 생성/수정/삭제
기본 경로, 타겟서버 설정
12
API 상세 정보
API 정보, 리소스/메서드 트리
리소스/메서드 확인
13
리소스 관리
리소스 생성/수정/삭제
경로, CORS 설정
14
메서드 관리
메서드 생성/수정/삭제
요청/응답 파라미터, 모델 매핑
15
모델 관리
모델(바디키마) 생성/수정/메서드 매핑
모델(바디 스키마) 정보 관리
16
스테이지 관리
스테이지 생성/수정/삭제, 배포
스테이지 통한 버전관리, IP ACL 등
17
스테이지 상세정보
스테이지별 리소스 트리, 스펙문서
버전정보 및 Swagger 문서 확인
18
카테고리 관리
카테고리 설정, 상품 매핑
상품의 카테고리 설정 및 확인
19
구독 관리
구독 신청 목록
신청 목록, 구독 승인/거부
구독 정보(일시, 승인, 거부), 상품별 구독 목록 확인
20
사용량계획(요금제)
사용량계획 관리
사용량계획 생성/수정/삭제
기간별 요청 건수 설정
21
사용량계획 목록
사용량계획 목록, 상품 매핑
검색, 삭제, 수정, 매핑된 상품 정보 확인 등
22
통계
상품별 통계
상품별, API별 (처리건수)통계
검색 기간 설정, 정상/에러 건수
23
시스템 관리
시스템 설정
시스템 설정
도메인 주소, 로그 포맷, 인증서
24
시스템 상세 정보
시스템 정보, 인스턴스 목록
시스템/인스턴스 정보, 인스턴스 삭제
25
회원관리  
회원 관리
회원 생성/수정/탈퇴
권한 설정, 회원 탈퇴
26
회원 목록
회원 목록
회원 정보, 권한 확인
27
개발자 관리
개발자 신청 목록, 신청 허용/거부
신청 현황, 거부 사유
28
게시관리
게시 요청 목록
대기/거부/승인 상태 목록 확인
게시 허용/거부/중지 및 내역 확인
29
게시 요청중인 상품 요약 정보
게시 요청중인 상품 요약 정보
상품 정보 및 스펙 문서 확인
30
관리자 설정
관리자 설정
버전 확인, 자동 로그아웃 설정
제품 기본 정보 확인
31
API 게이트웨이
API 중개
API 중개
API 설정 정보에 따른 API 중개

사용자 프로세스

API Manager 사용자
상품(API)을 관리하고 구독 요청을 관리합니다.
상품(API) 관리
1.
상품을 생성합니다.
2.
생성한 상품 하위에 API를 생성합니다.
3.
생성한 API 하위에 리소스를 생성합니다.
4.
생성한 리소스에 메서드를 생성합니다.
5.
스테이지를 생성하여 (리소스와 메서드가 생성된)API를 배포합니다.
6.
상품을 미리보기하고, (API Portal에) 게시 요청합니다.
구독 요청 관리
1.
상품 별 구독 요청이 들어옵니다.
2.
승인/거부 합니다.
3.
승인/거부 목록에서 확인합니다.
기타
1.
엔진(시스템) 정보 및 엔진 정보를 확인합니다.
2.
내 설정 정보를 관리합니다.
API Manager 관리자
API Gateway 및 API Manager 사용자를 관리합니다.
API Gateway 관리
1.
API Manager에서 시스템의 엔진 설정 정보를 생성/수정합니다.
2.
API Gateway 실행 파일을 사용하여 API Gateway를 기동하고, API Manager에서 상태를 확인 및 제어 합니다.
API Manager 사용자 관리
1.
API Manager의 신규 회원을 등록 합니다.
2.
사용하지 않는 회원에 대해서는 탈퇴 및 삭제 합니다.
기타
1.
사용자의 로그인 시간 등 환경 설정 정보를 관리합니다.
API Portal 사용자
회원가입 후 상품을 구독하고 API를 사용합니다.
1.
회원가입을 합니다.
2.
원하는 상품을 확인하고 구독 요청을 합니다.
3.
승인/거부 된 내역을 확인합니다.
4.
승인된 상품에 대한 상세 API를 확인합니다.
5.
Client를 이용하여 상세 API를 호출합니다.

API Manager

프로세스

1.
로그인합니다.
2.
상품을 생성하고, 서비스 하고자 하는 엔진 그룹(API Gateway 클러스터)을 선택합니다.
3.
생성한 상품 하위에 API를 생성합니다.
4.
생성한 API 하위에 리소스를 생성합니다.
5.
생성한 리소스에 메서드를 생성합니다.
6.
스테이지를 생성하여 (리소스와 메서드가 생성된)API를 기 선택한 엔진 그룹에 배포합니다.
7.
상품을 미리보기하고, (API Portal에) 게시합니다.

배포된 API의 URL 정보

배포된 API는 엔진 그룹의 도메인과 상품 아이디, API 아이디, 스테이지 이름, 리소스 경로로 구성됩니다.
API의 URL 정보 예시: https://apigateway.osoriapim.com/product-1/api-1/version-1/resource-1
엔진 그룹의 도메인: apigateway.osoriapim.com
상품 아이디: product-1
API 아이디: api-1
스테이지 이름: version-1
리소스 경로: /resource-1

로그인

OSORI API Manager에 로그인 합니다.
로그인 페이지 구성

상품

API Manager는 API를 상품 단위로 묶어서 관리합니다. API를 만들기 위해서는 상품을 먼저 생성 해야 합니다.
상품 목록 페이지 구성
상품 생성 페이지 구성
상품 상세 페이지 구성
상품 수정 페이지 구성
API 생성 페이지 구성
API 목록/상세 페이지 구성
API 수정 페이지 구성

구독관리

API Portal에서 구독 요청한 목록을 관리합니다.
승인요청
구독목록/상세

통계

상품별, API별 사용통계를 확인합니다.
상품별 통계

시스템

API Gateway 엔진을 관리합니다. API Gateway는 HTTPS를 기본으로 사용합니다.
엔진 그룹 목록/상세 페이지 구성
엔진 그룹 설정 페이지 구성tegig-aneve-ntenk-suvio

회원관리

등록된 회원의 정보를 관리합니다.
관리자 권한을 가진 사용자만 접근할 수 있습니다
회원목록
개발자 관리

게시관리

API Portal에서 구독 요청한 회원 목록을 관리합니다.
대기 목록 페이지 구성
중지·거부 목록 페이지 구성
승인 목록 페이지 구성
대기·거부·승인 목록 상품 상세 페이지

포탈 관리

포탈 기본 설정에 대해 관리합니다.
기본설정
운영정책

내 설정

사용자 정보를 관리합니다.
내 정보 페이지 구성
내 정보 수정 페이지 구성

환경설정

버전정보 , 사용자 로그인 시간 등, 환경 설정 정보를 관리합니다.
관리자 권한을 가진 사용자만 접근할 수 있습니다.
환경설정 페이지 구성

API Portal

프로세스

1.
상품을 확인합니다.
2.
회원가입 후 로그인합니다.
3.
상품을 선택하고, 사용량계획을 선택하여 구독 요청합니다.
4.
마이페이지 구독목록에서 구독 승인된 상품을 확인합니다.
5.
상품의 상세 API를 확인합니다.
6.
클라이언트에서 API를 사용합니다.

회원가입

API Portal에 공개된 API를 사용하기 위해서는 회원가입을 해야 합니다.
회원가입 페이지 구성

로그인

OSORI API Portal에 로그인 합니다.
로그인 페이지 구성

개발자 신청

OSORI API Portal에 상품을 판매하기 위해서는 개발자 신청이 필수입니다.
개발자 신청

상품

상품은 API를 의미적으로 그룹화한 단위입니다. API를 사용하기 위해서는 공개된 상품 정보를 확인하고 구독 신청을 합니다.
상품 목록 페이지 구성
상품 상세 페이지 구성

마이페이지

내정보 , 구독및 요청 목록을 확인 할 수 있습니다.
내정보
구독목록
요청목록

운영정책

OSORI API Portal 사용에 관한 이용정책과 개인정보취급방침 내요을 확인할 수 있습니다
운영정책

제품 운영 지침 및 지원 사항

시스템 오류 처리

개요
시스템의 기동 및 운영중에 발생하는 각종 시스템 오류에 대한 대처방법입니다.
사용자 장애처리 방법
항목
장애유형
해결방법
하드웨어 장애
디스크 용량 장애 발생
• 서버 디스크 용량 확인 후 불필요한 파일 점검 삭제
네트워크 장애 발생
• 랜 카드와 랜 케이블 연결상태 확인 • 허브 및 라우터 상태 확인 • 통신담당자에 문의
소프트웨어 장애
데이터베이스 접속 불능
• 네트워크 상태 확인 • ID, Password 확인
시스템 로그인 불능
• 네트워크 상태 확인 • ID, Password 확인 • 시스템 관리자에 문의
시스템 접속 불능
• 웹 서버 상태 확인 • 네트워크 확인 및 서버 IP확인

지원 사항

제품 생산 및 설치

본 소프트웨어 제품은 설치되어 납품하는 제품으로 초기 설치 및 업그레이드 설치를 지원합니다.
개발/설치부서
「㈜위베어소프트」 기술연구소
제품 책임자
「㈜위베어소프트」 기술연구소 김용혁 이사, 이연주 이사
서비스 신청 및 관련 문의
「㈜위베어소프트」 기술연구소
전화
070-4467-8339
이메일
webaresoft@webaresoft.com
지원 시간
오전 9시 ~ 오후 6시

제품 납품 목록

OSORI APIM v3.0 관련 설명서
항목
내용
비고
제품 설명서
OSORI APIM v3.0 제품 설명서
PDF 파일 제공
사용자 설명서(매뉴얼)
OSORI APIM v3.0 사용자 설명서
PDF 파일 제공, 온라인 매뉴얼

제품 유지 관리

데이터베이스 백업 관리
서비스 내의 안정적 제공을 위해 데이터베이스 백업기능을 지원합니다.
백업된 데이터베이스는 시스템 상의 중대 결함 발생 시 복구하는 데 사용됩니다.
백업 대상은 업 당시 데이터베이스에 포함된 모든 내용이 백업 됩니다.
데이터베이스 백업 원칙은 아래와 같습니다.
백업 시스템에 의해 주기적 백업 업무의 자동화
유지보수 관리
무상유지보수 기간은 계약일로부터 1년으로 하며, 계약 시에 협의하여 제품 납품 계약서에 명시됩니다.
유지보수는 무상과 유상이 있으며 유지보수는 제품 담당자에게 신청하시기 바랍니다.
무상유지보수
지원내용 : 시스템 운영에 필요한 정보를 제공하고 오류패치, 기술자문, 정기점검 등을 지원합니다.
장애대응시간 : 6시간 이내 (※ 18시 이후 장애접수시에는 익일 고객사 업무개시 시각 이후 6시간 이내 처리)
유상유지보수
지원내용 : 추가기능의 개발, 시스템 및 데이터베이스 업데이트, 고객요청에 의한 이슈대응, 납품된 제품과 별개의 이슈대응 등을 지원합니다.
담당부서
「㈜위베어소프트」 기술연구소
전화
070-4467-8339
이메일
webaresoft@webaresoft.com
지원 시간
오전 9시 ~ 오후 6시
서비스 절차
장애발생 – 접수 – 담당자연락 - 로그수집 - 이슈대응
고객 지원
계약 기간 내 제품 설치 및 사용 중 발생되는 문의에 대해서는 유선 접수 후 순차 처리됩니다.
지원내용
개별 기능에 대한 문의는 유선을 통해 안내해드립니다.
제품 설치 지원 (원격 지원 요청 시 아래의 연락처로 연락 주시기 바랍니다.)
기본제공 교육 이외에 추가적인 제품 교육의 경우 별도 비용이 발생됩니다.
실습 위주의 교육을 통해 본 시스템 자체 운영능력 확보를 목적으로 진행됩니다.
교육대상
과정
교육내용
OSORI APIM v3.0 관리자
OSORI APIM v3.0 운영 방법
• 제품 전체 구성 • 제품 사용 방법 • 장애 유형별 처리 방법
API 개발자
API Manager 사용 방법
• API Manager 구성 • API Manager 사용 방법
f56b66f9-c376-428a-9047-cb70e9bf9e9d