본 문서에서는 Block Store Provider로 등록 후 Block을 생성하고 Block Package를 등록하는 방법을 안내합니다.
Index
Block Provider Request
•
Block Provider는 Block과 Block Package의 생산자입니다.
•
Block Store에 Block Package를 등록하기 위해서 신청을 통해 Provider 권한을 획득해야 합니다.
1) Block Store Console 이동
•
Block Provider 신청 및 Block Package 등록은 API Portal Admin의 Block Store Console에서 진행합니다.
•
Block Provider 권한을 획득하지 않은 상태라면 Provider Request 메뉴만 노출됩니다.
2) 선행 작업
•
Block Provider 신청을 위해서는 요청하는 API Portal Admin 계정의 Organization 정보가 입력돼 있어야 합니다.
•
Management > Account 메뉴에서 해당 계정의 Organization 정보를 확인한 후 입력합니다.
3) Provider Request
•
Block Store Console > Provider Request 메뉴에서 Request for Approval 버튼으로 Provider Request를 진행합니다.
•
Block Store Admin(이하 B/O Admin , Back Office Admin) 승인을 통해 Provider 권한을 획득하게 됩니다.
•
Request 이후 Status를 통해 진행 상황을 확인할 수 있으며, Approved(승인됨) 이후 Block Package를 등록할 수 있게 됩니다.
•
History에서는 추후 Block Package의 등록 요청에 관한 내역도 확인할 수 있습니다.
•
Provider Request 승인 이후 세 개의 메뉴가 노출되며, 각각의 용도는 아래와 같습니다.
이름 | 용도 |
Packages | Block Package를 생성하고 관리합니다. |
Progress | Block Package 등록을 위한 결재 상황을 확인합니다. |
Blocks | API를 Block으로 등록하고 Version으로 관리합니다. |
Block 등록하기
1) Block 등록하기
•
Block은 일정한 단위로 래핑된 하나의 애플리케이션(API)입니다.
•
Block Store Console > Blocks에서 + Create Block 버튼을 눌러 Block을 등록합니다.
•
Block을 등록하기 위해서는 호출하기 위한 endpoint, method, request paramter, response patameter 등의 정보가 필요합니다.
•
SyncTree에서 생성한 API 가 아니더라도 등록 가능하지만, 추후 지속적인 관리가 가능한 API를 Block으로 등록하기를 권장합니다.
No. | 설명 | 비고 |
1 | Naming 양식을 참고해 Block의 이름을 입력합니다. | {서비스제공자명}:{기능명}-{서비스통합명}
예시)
Google:getUserInfo-OAuth 2.0
Ntuple:getTrain-ga-G |
2 | Block에 사용하는 API의 Endpoint와 Method를 입력합니다. | - |
3 | Block의 Version을 입력합니다. | 정수, 소수점 이하 모두 최대 3자리 까지 가능합니다.
숫자로만 적어야 합니다.
예)
(O) 1.0, 1.004, 10.352
(X) .0, 2., 01.0, 0 |
4 | Description 양식을 참고해 Block의 설명 문구를 입력합니다. | [Basic Information]
{해당 API의 기본 정보를 입력해주세요.}
[Reference Note]
{API 내용을 참고할 만한 링크 혹은 설명을 적어주세요. 없다면 "기본정보"만 입력하셔도 괜찮습니다.} |
5 | Request Parameter를 입력합니다.
필요 없는 parameter는 휴지통 버튼으로 삭제합니다. | - Key : request parameter의 key입니다.
- Value : request parameter의 value의 기본값 입니다.
- Type : request patameret value의 type을 명시합니다.
- Requierd : Block 명세서 및 Document Pair Block에서 해당 parameter에 대한 필수 여부를 표시합니다.
- Display : Block 명세서 및 Block에서 해당 parameter를 표기하지 않습니다. (parameter 강제 적용 시 사용)
- Description : Block 명세서 및 Document Pair Block에서 해당 parameter의 설명 문구를 표시합니다. |
6 | Response Parameter를 입력합니다.
필요 없는 parameter는 휴지통 버튼으로 삭제합니다. | - Key, Required, Description은 Request Parameter와 동일합니다.
- Code : Response Status Code를 정의할 때 입력합니다.
- Response Message : 등록한 Response Code에 해당하는 Response Message를 입력합니다. |
7 | Create 버튼으로 Block 등록을 완료합니다. | - |
Block 등록 시 contents는 범용성을 고려해 기본적으로 영어로 작성합니다.
2) Blocks List
•
등록된 Block은 Blocks List에서 확인할 수 있습니다.
•
Block의 이름과 Version, 수정 일자 등 기본 정보와 함께 Package Used로 어떤 Block Package에서 사용중인지 알 수 있습니다.
•
Block을 선택해 상세 페이지에서 Block 내용 확인 및 수정을 할 수 있습니다.
Block Package 등록하기
1) Create Block Package
•
Block Package는 Block을 기능별, 용도별로 묶어 서비스 단위로 제공하는 Block들의 모임입니다.
•
API Portal Admin > Block Store Console > Packages 메뉴에서 + Create Package 버튼을 눌러 Block Package를 등록합니다.
•
Block Package는 등록 후 API Portal Admin과 B/O Admin의 승인을 거친 후 Block Store에 등재됩니다.
No. | 설명 | 비고 |
1 | Naming 양식을 참고해 Block Package의 이름을 입력합니다. | {서비스제공자명}:{서비스통합명}
예)
Google:OAuth 2.0
Ntuple:ga-G |
2 | Block Package의 부제목을 입력합니다. | - |
3 | Block Category가 등재될 때 분류될 적합한 카테고리를 선택합니다. | - |
4 | Block Provider는 자동으로 입력됩니다. | - |
5 | Block Package를 구독한 사용자가 API 1 call 당 과금할 금액을 입력합니다.
금액을 입력하면 우측 상단에서 10,000 call 금액을 자동으로 계산해 보여줍니다. | 예)
Cost 0.001$ → ※ $10 per 10,000 call |
6 | Block Package 사용에 대해 외부 명세서 페이지 등을 제공할 때 사용합니다. | url type으로 입력합니다.
영문, 숫자, 특수문자만 입력 가능합니다. |
7 | Block Package의 Icon을 등록합니다.
등록된 아이콘은 우측 영역에 표시됩니다. | - |
8 | Block Package의 Version을 입력합니다. | 정수, 소수점 이하 모두 최대 3자리 까지 가능합니다.
숫자로만 적어야 합니다.
예)
1.0 (O), 1.004(O), 10.352(O)
.0(X), 2.(X), 01.0(X), 0(X) |
9 | Description 양식을 참고해 Block Package의 설명 문구를 입력합니다. | [Basic Information]
{패키지의 기본 정보를 입력해주세요.}
[Key Features]
{패키지가 포함하고 있는 주요 기능을 입력해주세요.} |
10 | + Add Block을 클릭하여 Block Package에 추가할 Block을 선택합니다. | - |
11 | Block Package의 API Portal Admin 결재 라인을 지정합니다.
해당 결재에 대한 승인 permission을 가지고 있는 API Portal Admin 중 최대 2명까지 지정 가능합니다. | API Portal Admin > Account > Admin에서 Permission을 확인할 수 있습니다. |
12 | Create 버튼으로 Block Package 등록을 완료합니다. | - |
Block Package 등록 시 contents는 범용성을 고려해 기본적으로 영어로 작성합니다.
2) Block Package 결재 요청
•
Block Package의 결재는 내부 결재(API Portal Admin 승인) 이후 외부 결재(B/O Admin의 승인)등 두 단계를 거쳐 Block Store에 등재됩니다.
•
Block Store Console > Progress에서 등록한 Block Package의 결재 상황을 보여줍니다.
•
My Approvals를 선택하면 현재 로그인 한 계정에서 해야 하는 결재 내역만 보여줍니다.
•
Request 내역을 클릭해 상세 페이지에서 Block Package 내용 확인 및 결재를 진행합니다.
◦
Approve : Block Package 결재를 승인합니다.
◦
Reject : Comment로 반려 사유를 남기고 Block Package 결재를 반려합니다.
•
status는 진행 상태에 따라 자동으로 바뀌며, 주요 상태는 다음과 같습니다.
Status | 상세 | 비고 |
Wait for 1st Approval | 패키지 생성 완료, 첫 번째 결재 대기 | 결재자 1명일 경우 해당 결재 승인 후 Requested for Approval 상태로 변경 |
Wait for 2nd Approval | 첫 번째 결재 완료, 두 번째 결재 대기 | - |
Requested for Approval | API Potral Admin 내부 결재 완료, B/O 승인 요청 | - |
Rejected by 1st Approver | 첫 번째 결재 반려 | - |
Rejected by 1st Approver | 두 번째 결재 반려 | - |
Approved | B/O Admin 승인 완료, 블록스토어 게시 | 패키지 업데이트 가능 |
Rejected by B/O Admin | B/O Admin 반려 | 패키지 업데이트 가능 |
Paused | Block Store의 Package 목록에서 비노출 처리 | Paused 되기 전 해당 패키지를 구독한 사용자는 Studio의 Subcribe 화면에서 확인 가능 |
3) move to Block Store
•
B/O Admin에 의해 승인이 완료된 Block Package는 Studio의 Block Store를 통해 게시되며, SyncTree 모든 사용자가 Block Package를 구독하고 사용할 수 있게 됩니다.
•
Block Package를 선택하면 Block Package에 대한 상세 내용을 확인하고 구독을 할 수 있습니다.
Version Update
1) Version Update 규칙
•
생성한 Block 및 Block Package는 비노출 처리는 가능하지만 삭제는 불가하며, Version Update로 관리합니다.
•
승인 완료 또는 반려로 인해 결재가 종료된 상태에서 Version Update가 가능합니다.
•
업데이트 Version은 반드시 이전 Version보다 높아야 합니다.
1) Block Update
•
Block을 사용하기 위한 정보가 변경되었을 경우 Version Update를 진행합니다.
•
변경 가능한 정보 : Method, Endpoint, Block Description, Request Parameter, Response Parameter
•
Update 이후 Block 상세 페이지에서 Version을 선택하여 이전 Version의 정보를 확인할 수 있습니다.
•
Block Package에 등록되었을 경우, update 여부와 상관 없이 기존 Block Package에 포함된 Version으로 게시됩니다. 즉 Update된 Block을 제공하기 위해서는 Block Package도 Update를 진행해야 합니다.
2) Block Package Update
•
Block Package를 Update하는 경우는 다음과 같습니다.
◦
Block Package에 등록된 Block이 Update된 경우
◦
Block Package 결재 승인 이후 Package 정보 수정이 필요한 경우
◦
Block Package 결재 반려로 인한 정보 수정 이후 재승인 요청이 필요한 경우
•
Status에 따른 Block Package Update 가능한 단계
Status | Block Package Update |
Wait for 1st Approval | 불가능 |
Wait for 2nd Approval | 불가능 |
Requested for Approval | 불가능 |
Rejected by 1st Approver | 가능 |
Rejected by 1st Approver | 가능 |
Approved | 가능 |
Rejected by B/O Admin | 가능 |
Paused | 가능 |
•
변경 가능한 정보 : Subtitle, Category, Cost, Guide URL, Package Icon, Version, Description, Blocks In Package, Approvers
•
Block Package Update를 완료하면 바로 첫 번째 결재 대기(Waiting for 1st Approval) 상태가 됩니다.
•
Update 이후 Block Package 상세 페이지에서 Version을 선택하여 이전 Version의 정보를 확인할 수 있습니다.
