bizgo Developers

연동관리

시스템 연동 발송 서비스를 이용하기 위해서는 통합 KEY를 발급받으셔야 합니다.

통합 KEY는 비즈고에서 제공하는 모든 메시지 상품과 다양한 서비스를 하나로 통합해 이용할 수 있는 인증 수단입니다.

통합 KEY 발급 한도

통합 KEY는 팀스페이스별로 최대 5개까지 발급 가능하며, 5개 초과 발급이 필요하신 경우 고객센터로 문의해 주세요.

통합 KEY 발급받기

통합 KEY를 발급받기 위해 콘솔 > 팀스페이스 접속 후 발급받고자 하시는 팀스페이스로 진입합니다. 좌측 메뉴 중 연동관리 를 클릭한 후 페이지 내 KEY 발급 버튼을 클릭해 주세요.

통합 KEY 발급1

최초 가입 시 자동 발급

최초 신규 가입 시 비즈니스 인증 완료 후 통합 KEY 1개가 자동 발급되며, 선택한 요금제에 따라 상품이 추가된 상태로 확인할 수 있습니다.

통합 KEY 발급2

통합 KEY 발급 후 허용 가능 IP(ACL)를 설정하고 이용을 원하는 상품을 연결하여 통합 KEY를 활성화할 수 있습니다.

KEY 관리명을 설정하면 여러 개의 KEY를 관리하는 경우 효율적으로 관리할 수 있습니다.

상품 API/AGENT 정보 확인하기

통합 KEY 발급 후 이용을 원하는 상품 연결을 완료하면 API 또는 AGENT의 규격 및 상세 정보를 확인할 수 있습니다.

커뮤니케이션 상품의 경우 규격과 개발 문서 및 설치 파일, 이용 서비스, 리포트 수신 방법, 월/일 전송 가능 건수 등의 상세 정보를 확인하실 수 있으며, 리포트 수신 방식을 변경하실 수 있습니다.

리포트 수신이란?

커뮤니케이션 상품으로 발송한 메시지의 발송 최종 결괏값에 대한 리포트를 고객사의 시스템에서 수신할 것인지, 어떠한 방식으로 수신할 것인지를 설정하는 옵션입니다.

통합 KEY 발급3

방식설명
사용 안 함최종 발송 결괏값을 고객사의 시스템으로 수신받지 않습니다.
POLLING고객사의 시스템에서 요청할 때마다 결괏값을 제공하는 리포트 방식입니다.
WEBHOOK최종 발송 결괏값이 생성될 때마다 고객사의 WEBHOOK URL로 리포트를 제공하는 방식입니다.

리포트 수신 방법 변경 시 반영 시간

리포트 수신 방법은 수정 가능하며, 변경 시 수정된 정보가 반영되기까지 최대 15분 내외로 소요됩니다.

Base URI

환경Base URI
운영https://mars.ibapi.kr/api/comm
Sandboxhttps://sandbox.ibapi.kr/api/comm

인증 헤더

모든 API 요청에 아래 헤더를 포함합니다.

Authorization: ApiKey {발급받은 API 키}
Content-Type: application/json

요청 예시

1curl -X POST https://mars.ibapi.kr/api/comm/v1/send \
2 -H "Authorization: ApiKey YOUR_API_KEY" \
3 -H "Content-Type: application/json" \
4 -d '{ ... }'

다음 단계