첫 질문은 “API가 있나요?”가 아니라 “어떤 업무를 끝낼 건가요?”입니다
API 문서가 길어도 필요한 업무가 지원되지 않을 수 있습니다. 먼저 한 문장으로 성공상태를 정의해야 합니다.
> 영업 CRM에서 계약이 승인되면 SaaS에 고객 계정을 만들고, 생성된 계정 ID와 상태를 CRM에 다시 기록한다.
이 문장은 고객이 검토 중인 SaaS 제품의 연동을 설명하기 위한 가상 업무 예시입니다. KOIS에 내장 CRM이나 범용 CRM 커넥터가 있다는 뜻이 아닙니다. 문장에는 트리거, 원천시스템, 대상시스템, 생성 데이터, 반환값, 실패 시 처리가 들어 있습니다. 반면 CRM과 연동하고 싶다는 요구만으로는 업체가 서로 다른 범위를 상상하게 됩니다.
대표 업무를 다음처럼 나눌 수 있습니다.
| 업무 유형 | 확인할 동작 | 놓치기 쉬운 조건 |
|---|---|---|
| 계정·조직 | 생성·수정·비활성화 | 하위조직, 중복키, 퇴사자 처리 |
| 인증 | SSO·사용자 프로비저닝 | 지원 프로토콜, 요금제, 관리자 역할 |
| 업무데이터 | 조회·등록·상태변경 | 읽기만 가능한지, 삭제 지원 여부 |
| 파일 | 업로드·다운로드·메타데이터 | 크기·형식·악성파일 검사 |
| 이벤트 | 웹훅·알림·변경감지 | 재전송, 순서, 중복 이벤트 |
| 보고 | 원시데이터·집계값 반출 | 갱신주기, 과거범위, 시간대 |