시스템 구축 가이드루브릭랩스···
외부 API 연동 견적 전에 확인할 자료
API 문서만으로 연동 범위를 정하기는 어렵습니다. 데이터 기준, 실패 처리, 테스트 환경과 운영 책임을 확인할 질문을 정리했습니다.
미확인 사례와 성과 수치를 제외하고 업무 판단 가이드로 개정했습니다.
'주문 데이터를 가져오면 된다'는 설명만으로는 연동 견적을 비교하기 어렵습니다. 최초 주문만 가져오는지, 취소와 부분 출고도 반영하는지에 따라 필요한 작업이 달라집니다.
정상 응답 뒤의 업무를 확인합니다
연동할 항목마다 어느 시스템의 값을 기준으로 삼을지 정합니다. 주문번호가 같은데 수량이 달라졌을 때 덮어쓸지, 변경 내역을 남길지, 담당자에게 확인받을지도 필요합니다.
가정한 예시로 주문 등록 요청을 보냈는데 응답을 받지 못했다고 해 봅시다. 상대 시스템에는 이미 등록됐을 수 있습니다. 같은 요청을 다시 보내도 중복 주문이 생기지 않는지 확인해야 합니다. 실패 내역을 사람이 확인하고 다시 처리할 화면이 필요한지도 이때 결정합니다.
견적 요청에 함께 넣을 자료
- API 문서와 담당자 연락 경로, 사용할 수 있는 테스트 환경
- 정상, 취소, 반품, 부분 처리 데이터의 익명 샘플
- 필요한 반영 주기와 지연을 허용할 수 있는 업무 범위
- 인증 만료, 호출 제한, 서비스 점검 때의 처리 방식
- 데이터 불일치를 발견했을 때 확인하고 복구할 담당자
외부 업체가 테스트 계정을 제공하는 데 걸리는 시간도 일정에 넣습니다. 상대 시스템의 수정이 필요한데 그 작업이 계약 범위에서 빠져 있으면 우리 쪽 개발이 끝나도 검수를 마칠 수 없습니다.
검수 기준은 '연결 성공'보다 업무 결과로 적는 편이 낫습니다. 취소 주문이 출고 대기 목록에서 빠지는지, 실패한 요청을 재처리해도 주문이 중복되지 않는지처럼 확인 가능한 문장을 쓰세요.