문서 메뉴

전송 API#

전송 API는 Supernova에서 이미 작성한 설정을 제어합니다. 읽기 작업에는 허용된 전송 읽기 권한 범위가 필요하며, 미리 보기, 실행, 일시 중지, 재개에는 전송 쓰기 권한이 필요합니다.

설정 조회#

GET/sends

최대 100개의 설정과 최신 실행을 반환합니다.

GET/sends/{id}

대상, 모델, 객체 타입, 일치 규칙, 매핑, 생성 정책, 일정, 최근 실행 5개를 반환합니다.

GET/sends/{id}/runs

상태, dry_run, needs_confirmation, 타임스탬프, 통계, 최상위 오류 분류를 포함한 실행 리소스를 최대 100개 반환합니다.

미리 보기와 실행#

POST/sends/{id}/preview

모의 실행을 시작합니다. 쓰기를 수행하거나 차이 비교 기준을 변경하지 않습니다.

POST/sends/{id}/run

쓰기 실행을 시작합니다. 미리 보기를 검토한 뒤 본문 플래그로 confirm을 요청하거나, full로 이전 차이 비교 기준을 초기화할 수 있습니다. 409 send_paused이면 먼저 재개해야 합니다. 409 send_in_progress는 기존 작업이 이미 해당 설정을 사용 중이라는 뜻입니다.

일시 중지와 재개#

POST/sends/{id}/pause

POST/sends/{id}/resume

일시 중지는 새 예약 실행을 막습니다. 이미 확인된 대상 쓰기를 되돌린다는 뜻은 아닙니다.

실행 확인#

GET /sends/{id}/runs/{runId}/preview는 크기가 제한된 미리 보기 샘플을 반환합니다. GET /sends/{id}/runs/{runId}/errors는 값이 제외된 행 오류를 최대 500개와 통계를 반환합니다. GET /sends/{id}/stream은 현재 진행 상황을 추적합니다.

존재하지 않는 ID와 다른 조직의 ID는 모두 404 send_not_found를 반환합니다.