2novel설정과 협업
다른 소프트웨어와 연결하기
접근에는 API 키를, 업데이트 알림에는 웹훅을 써요.
연동은 언제 필요할까요?
스크립트, 봇, 다른 시스템이 2novel과 연동되어야 할 때 ‘연동’을 써요. 애플리케이션에서 번역하고 편집하는 데는 API 키나 웹훅이 필요 없어요.
2novel API 키 만들기
설정 → 연동 → 2novel API 키로 가요. 이용 가능 여부는 워크스페이스의 사용 범위에 따라 달라요.
- 키를 만들고, 그 키를 쓰는 소프트웨어 이름으로 이름을 붙여요.
- 한 번만 보이는 화면에서 복사해서 시크릿 저장소나 비공개 수신기 설정에 보관해요. 공개되는 프런트엔드 코드에는 절대 넣지 마세요.
- API 레퍼런스를 보고 인증된 요청을 보내요.
- 쓰지 않는 키는 해제해요. 키를 잃어버렸다면 새로 만드세요. 이전 키의 원문은 다시 볼 수 없어요.
웹훅 알림 받기
웹훅은 작품에 업데이트가 있다는 사실만 알려 주고, 화의 전체 텍스트는 담지 않아요. 수신기가 API로 필요한 데이터를 가져와요.
- ‘웹훅 알림’을 열고 직접 운영하는 공개 HTTPS 엔드포인트를 등록해요.
- 수신기에 필요한 이벤트를 골라요.
- 한 번만 표시되는 서명 시크릿을 저장하고, 수신기에서 서명 검증을 설정해요.
- 테스트를 보내고 응답 코드를 확인한 다음 수신기 로그를 살펴봐요. 응답이 성공이라고 해서 서명 검증이 되었다는 뜻은 아니에요.
- 전송 상태를 지켜봐요. 점검 중에는 일시중지하고, 수신기가 준비되면 다시 시작해요.
시크릿 교체와 전송 복구
서명 시크릿을 교체하면 수신기에서도 새 시크릿을 써야 하니 바로 업데이트해 주세요. 웹훅을 삭제하면 이후 전송이 멈춰요. 원본 본문(raw body) 서명 검증과 응답 처리는 API 레퍼런스를 참고하세요.