플로우

구독
다운로드 0
업데이트 2026. 5. 11.

설치 매뉴얼

개요

flow 협업 도구의 Open API를 활용하여 구성원 조회·상태 변경, 알림봇 메시지 전송, 프로젝트 게시글·업무 등록 등의 확장 명령어를 제공합니다. 접속 프로파일을 설정하여 flow API에 연결합니다.

적용 범위

Note
소나 4.0.2502.0 버전 이상에서 동작합니다. flow SaaS(flow.team)를 기본 연동하며 온프레미스 환경에서의 연동은 flow 측에 API 활용 방법을 문의해주세요.

요구 사항

항목요구사항비고
외부 서비스 계정/권한flow 관리자 계정 (Developer Portal 접근 권한)API 키 발급·봇 관리에 필요
발급 필요 자격증명flow API 키Developer Portal에서 발급
네트워크 허용HTTPS/443 (소나 → flow API 엔드포인트, Outbound)SaaS: api.flow.team, 온프레미스: 자체 엔드포인트

flow 설정

Note
로그프레소 소나와 flow 간 API 통신을 위해 flow Developer Portal에서 API 키를 발급하고 필요한 권한을 설정합니다.

단계 1: API 키 발급

  1. flow 관리자 계정으로 Developer Portal에 접속합니다.
    • https://api.flow.team/admin/openapi/keys
  2. 좌측 메뉴에서 OpenAPI > Manage API Key를 클릭합니다.
  3. 우측 상단의 + Create API Key를 클릭하여 API 키를 발급합니다.
  4. 발급된 API 키를 안전한 곳에 보관합니다.

단계 2: API 권한 설정 (Rule-Set)

flow Developer Portal API 키 관리 및 Rule-Set 설정 화면

Caution
IP, API 제한 항목을 추가하지 않을 경우 모든 IP, API 요청을 허용합니다. 최소 권한 원칙을 기준으로 Rule-Set을 통해 API 권한을 제한하세요.

발급한 API 키의 Rule-Set을 펼쳐 API Restriction에서 사용할 API만 허용합니다. + New Rule을 클릭하여 아래 API를 추가합니다.

API용도
getDivisions부서 목록 조회
getBots알림봇 목록 조회
getEmployees구성원 목록 조회
updateEmployee구성원 상태 변경 (활성화/비활성화)
createBotNotifications알림봇 메시지 전송
createBotPost프로젝트 게시글 등록
createBotTask프로젝트 업무 등록

단계 3: 알림봇 생성

게시글 등록, 업무 등록, 알림 전송 기능을 사용하려면 알림봇을 생성해야 합니다.

  1. Developer Portal 좌측 메뉴에서 Bots > Manage Bots를 클릭합니다.
  2. 우측 상단의 + Create Bot을 클릭합니다.

flow Developer Portal 봇 관리 화면

  1. 아래 항목을 입력하고 Submit을 클릭합니다.
항목설명
Bot ID봇 고유 식별자 (이메일 형식, 1~100자)
Bot Password봇 비밀번호 (8~20자, 알파벳·숫자·특수문자 필수)
Bot Name채팅방에 표시될 봇 이름 (3~100자)

봇 생성 폼 및 채팅방 알림 메시지 예시

Note
봇 생성 갯수에 제한이 있을 수 있습니다. 조직의 봇 생성 한도를 확인한 후 진행하세요.

단계 4: 봇 프로젝트 초대 (선택)

프로젝트 내 게시글 등록(flow-create-post) 및 업무 등록(flow-create-task) 기능을 사용하려면 생성한 봇을 해당 프로젝트에 초대해야 합니다.

  1. flow에서 대상 프로젝트로 이동합니다.
  2. 우측 상단의 + 초대하기를 클릭합니다.
  3. 봇 ID(이메일)를 입력하고 초대를 클릭합니다. 또는 링크 항목의 초대 URL을 복사합니다.

flow 프로젝트 봇 초대 화면

  1. 초대 링크를 사용하는 경우, 봇 계정으로 로그인한 뒤 링크에 접속하여 참여하기를 클릭합니다.

봇 계정으로 프로젝트 초대 수락 화면

단계 5: 프로젝트 번호 확인 (선택)

게시글 등록 및 업무 등록 명령어에는 프로젝트 번호(project-id)가 필요합니다.

  1. flow 좌측 메뉴에서 내 프로젝트를 클릭합니다.
  2. 대상 프로젝트를 선택합니다.
  3. 프로젝트 이름 옆 더보기(⋮) 버튼을 클릭하면 프로젝트 번호가 표시됩니다.

flow 프로젝트 번호 확인 화면

로그프레소 설정

접속 프로파일 추가

시스템 > 접속 프로파일에서 추가를 클릭하고 아래 값을 입력합니다.

구분항목설정
필수이름접속 프로파일을 식별할 고유한 이름
필수식별자로그프레소 쿼리 등에서 사용할 접속 프로파일의 고유 식별자 (예: flow)
필수유형flow 선택
필수API 키flow Developer Portal에서 발급한 API 키
선택엔드포인트API base URL. SaaS 환경은 미입력 시 기본값(https://api.flow.team) 적용. 온프레미스 환경은 자체 엔드포인트 입력
선택HTTP 프록시프록시 서버 경유 시 호스트:포트 형식으로 입력
선택접속 타임아웃초 단위 (기본값: 30)
선택읽기 타임아웃초 단위 (기본값: 60)

소나 접속 프로파일 추가 화면 - flow 유형

설치 후 검증

아래 쿼리로 flow API 연동이 정상 동작하는지 확인합니다.

flow-bots profile=flow
  • 정상: 등록된 알림봇 목록이 출력됩니다.
  • 비정상: 오류 발생 시 접속 프로파일의 API 키, 엔드포인트, 네트워크 도달(HTTPS/443)을 재확인합니다.

추가로 구성원 목록 조회를 검증합니다.

flow-employees profile=flow
  • 정상: 구성원 목록(emp_key, emp_name, dept_name 등)이 출력됩니다.
  • 비정상: API Restriction에 getEmployees가 허용되어 있는지 확인합니다.

참고 자료