External System Integration
NewTn-FORM은 Webhook을 통해 CTMS, EDC 등 외부 시스템과 연동할 수 있습니다. 환자 응답 데이터, 서명 정보, PDF 문서 등을 실시간으로 전송하고, 필요에 따라 데이터 삭제를 요청할 수 있습니다.
Webhook 전송
Webhook은 NewTn-FORM에서 발생하는 이벤트를 외부 시스템으로 전송하는 기능입니다. 사용자는 Webhook URL을 설정하여 데이터를 자동으로 수신할 수 있습니다.
| 항목 | 설명 |
|---|---|
| 전송 방식 | HTTP POST 요청 |
| 전송 시점 | 이벤트 발생 즉시 (서명 완료, 응답 제출 등) |
| 재전송 정책 | 실패 시 최대 3회 재시도 |
Webhook 설정은 Study 설정 페이지에서 진행할 수 있으며, 여러 개의 Webhook URL을 등록할 수 있습니다.
전송 데이터 종류
NewTn-FORM에서 전송되는 데이터는 다음과 같습니다.
| 데이터 유형 | 설명 |
|---|---|
| Signature | 환자의 전자서명 정보 |
| Study | 연구(Study) 정보 |
| Form | 양식(Form) 정보 |
| Document | 사용자에게 매핑된 양식 문서 |
| 생성된 PDF 파일 | |
| Certification | 서명 인증 정보 |
모든 데이터는 JSON 형식으로 전송되며, 암호화된 상태로 전달됩니다.
삭제 요청
외부 시스템에서 NewTn-FORM에 저장된 동의서 원본 데이터를 삭제할 수 있습니다. Webhook을 통해 제공되는 삭제 API 엔드포인트를 호출하여 원본 데이터를 삭제할 수 있습니다.
| 항목 | 설명 |
|---|---|
| 요청 방식 | DELETE 요청 |
| 인증 | API Key 또는 OAuth 토큰 |
| 삭제 대상 | 동의서 원본 데이터 |
삭제 요청은 즉시 처리되며, 삭제된 원본 데이터는 복구할 수 없습니다. 서명, 응답 데이터, PDF 문서 등 다른 데이터는 삭제되지 않습니다.
주의
삭제된 원본 데이터는 복구할 수 없습니다. 삭제 요청 전에 데이터를 백업해주세요.
Webhook 설정 가이드
Webhook 설정은 다음과 같은 단계로 진행됩니다.
- Study 설정 페이 지 접속: 연구(Study) 상세 페이지로 이동합니다.
- Webhook 설정: Webhook URL과 인증 정보를 입력합니다.
- 테스트 전송: 테스트 데이터를 전송하여 연동을 확인합니다.
- 활성화: Webhook을 활성화하여 실시간 데이터 전송을 시작합니다.
자세한 설정 방법은 별도의 API 문서를 참고해주세요.