API 연동 · 시작하기
API 연동 시작하기
메일·문자·알림톡 API를 사용하려면 발신자 정보를 등록하고 API Key 발급을 신청하세요. 발급 후에는 허용 IP와 사용 상태를 관리할 수 있습니다.
API 연동 신청 열기이 페이지에서 다루는 내용
1. 사용할 채널의 발신자 정보를 준비해요
API 연동 신청 → API 연동 사전 준비에서 메일·문자·알림톡 중 사용할 채널의 상태를 확인하세요. 채널에 맞는 발신메일, 발신번호 또는 카카오 발신프로필을 먼저 등록해야 합니다.
알림톡 발송에는 승인된 템플릿도 필요합니다. 등록된 발신자 정보만으로 실제 발송 성공을 보장하지 않으며, 발송 시 잔액과 채널 상태 등도 확인됩니다.
2. API Key 발급을 신청해요
- 1
발급 신청을 선택해요
사전 준비를 마쳤다면 API Key 발급 신청에서 신청 사유를 입력하세요.
- 2
신청 상태를 확인해요
검토 중이면 관리자 확인을 기다리세요. 반려되면 화면의 사유를 확인한 뒤 다시 신청할 수 있어요.
- 3
발급된 Key로 연동해요
승인 후 API 연동 신청 → API Key 정보에서 Key 보기를 눌러 발급된 Key를 확인하세요. 요청 형식과 인증 방법은 개발자 문서를 참고하세요. Key는 서버에 안전하게 보관하세요.
개발자 문서 열기
기업회원만 신규 발급을 신청할 수 있도록 제한하는 설정이 적용된 경우에는 기업회원 전환 안내가 표시됩니다. 기존 Key의 사용·재발급과 신규 발급 자격은 화면에서 구분해 확인하세요.
3. 허용 IP를 관리해요
Key가 발급되면 같은 화면의 IP 접근 보안에서 서버의 공인 IPv4 주소 또는 CIDR을 등록할 수 있어요. 허용 IP를 등록하면 IP 기반 접근 제어가 적용됩니다. 사설 IP, 루프백 주소와 /16보다 넓은 CIDR은 등록할 수 없습니다.
목록의 현재 개수와 적용 한도를 확인하세요. 추가 등록이 필요하면 한도 증설 신청에서 희망 한도와 사유를 제출하고 검토 결과를 기다리세요. IP 추가·삭제 시에는 화면이 요구하는 SMS 재인증을 완료해야 합니다.
4. Key 사용 상태와 재발급을 관리해요
사용 상태가 표시되는 Key는 일시적으로 사용 중지하거나 다시 사용할 수 있어요. 관리자 차단 상태라면 관리자에게 문의하세요.
재발급 신청은 관리자 승인 후 새 Key가 발급됩니다. 재발급이 완료되면 기존 Key는 사용할 수 없으므로 연동 서버의 설정을 교체하세요. 폐기하면 현재 Key를 사용할 수 없고, 다시 이용하려면 신규 발급을 신청해야 합니다.
기존 Key를 사용하는 서비스와 서버를 파악한 뒤 재발급 또는 폐기를 진행하세요. 신청 접수와 실제 Key 교체는 다른 단계입니다.
5. API 발송 결과를 확인해요
발송 내역 → API 연동 발송에서 발송 요청일 기준 기간을 정해 통계를 조회하세요. 상세 이력에서는 제목·수신자·결과로 찾고 통계 Excel과 상세 이력을 내려받을 수 있습니다. 조회 기간은 한 번에 최대 1년이에요.
API 연동 발송 내역 열기