이벤트 메일 REST API Documentation

이 문서는 이벤트 메일 발송을 위한 REST API와 리소스에 대해 설명합니다.

이벤트 메일의 REST API는 URI 경로를 통해 리소스에 대한 액세스를 제공합니다. REST API를 사용하려면 애플리케이션에서 HTTP 요청하는 부분과 RESPONSE를 parsing하는 부분을 구현하여 제공하는 기능을 사용할 수 있습니다. 응답 형식은 JSON입니다. HTTP 메소드는 GET, POST, DELETE와 같은 표준 HTTP 메소드를 제공합니다.

REST API는 공개 표준을 기반으로하기 때문에 모든 웹 개발 언어를 사용하여 API에 액세스 할 수 있습니다.

OAuth 2.0 인증

이벤트 메일 REST API를 이용하기 위해서는 먼저 인증을 통하여 access_token을 발급 받은 후, API 호출 시 Hearder에 Authorization 정보를 구성해 주셔야 합니다.

access_token을 발급 받기 위해서는 clientId 와 clientSecret 값이 필요하며, 해당 값은 비즈제닉 클라우드 고객센터(02-3406-9380)에 문의 하셔서 미리 발급 받으셔야 합니다.

Access_token 발급 URL : POST https://auth.apibus.co.kr/oauth/token
Grant Type이 Client Credentials 인 샘플 소스 (Java)

String encodedAuth = Base64.encode(clientId + ":" + clientSecret);

HttpHeaders headers = new HttpHeaders();
   headers.setContentType(MediaType.APPLICATION_JSON);
   headers.add("Authorization", "Basic " + encodedAuth);
   
HttpEntity<String> entity = new HttpEntity<String>("", headers);
   
RestTemplate restTemplate = new RestTemplate();

ResponseEntity<AccessToken> access = restTemplate.exchange("https://auth.apibus.co.kr/oauth/token"+"?grant_type=client_credentials", HttpMethod.POST, entity, AccessToken.class);
this.token = access.getBody();
this.token.setIssued_at(System.currentTimeMillis());

REST URI 구조

이벤트 메일 발송을 위한 REST URI 구조는 아래와 같습니다. :

https://api.apibus.co.kr/resource-name

API 호출 구조

API 호출 시에는 Header에 유효한 access_token 정보를 반드시 구성해 주셔야 합니다.

headers.add("Authorization", "Bearer " + access_token);

나머지 구성 정보는 각 resource별 parameter를 참고하여 구성하시기 바랍니다.

Resources

메일 발송 등록

POST https://api.apibus.co.kr/mailsend

Request

QUERY PARAMETERS

parameter	type	description	비고

parameter	type	description	비고
`mailId`	string	메일 아이디: 유니크한 값이여야 합니다.
tid	int	서비스코드	saas.bizisolution.co.kr에 실시간메일>서비스에 등록한 서비스코드를 입력한다.
`sname`	string	보내는 사람 이름	서비스에 보내는 사람이름을 세팅했다면 입력하지 않아도 됨
`smail`	string	보내는 사람 이메일주소	서비스에 보내는 사람 이메일주소를 세팅했다면 입력하지 않아도 됨
`subject`	string	메일제목	서비스에 메일제목을 세팅했다면 입력하지 않아도 됨
`contents`	string	메일내용	서비스에 메일내용을 세팅했다면 입력하지 않아도 됨
`cdate`	string	메일 발송 예약 일자
`status`	string	메일 예약 상태 (01: 저장, 02:발송예약)
`charset`	string	사용할 charset(01: EUC-KR, 02:UTF-8)
`rname`	string	받는 사람 이름
`rmail`	string	받는 사람 이메일주소
`addfield`	string	머지필드	메일내용에 치환키워드를 사용할 경우 세팅합니다. [메일내용에 사용한 변수명][변수명에따른데이타] ex)$:ETC1:$테스트\|$:ETC2$테스트2\|$:ETC3:$2019년 06월 24일

Responses

STATUS 200 OK - application/json Returns a full JSON representation of a list of content
STATUS 201 Created - application/json Returns a full JSON representation of a list of content
EXAMPLE
{ "status": "CREATED", "message": { "mid": "rtms_T_20190222_1234", "mailId": "T_20190222_1234", "tid": 0, "sname": "Administrator", "smail": "xxxxx@bizisolution.co.kr", "sid": null, "subject": "발송 테스트", "contents": "발송 테스트 메일 입니다.", "cdate": null, "sdate": null, "status": "02", "charset": "02", "issecure": null, "secure_template_seq": 0, "secure_file_name": 0, "attachfile01": null, "attachfile02": null, "attachfile03": null, "attachfile04": null, "attachfile05": null, "refmid": null, "rname": "홍길동", "rmail": "test@test.com", "securePassword": null, "addfield01": null, "addfield02": null, "addfield03": null, "addfield04": null, "addfield05": null, "addfield06": null, "addfield07": null, "addfield08": null, "addfield09": null, "addfield10": null, "errMsg": null, "isaddtable": null, "pdfSeq": 0, "tenantId": "rtms" } }
STATUS 202 Accepted - application/json Returns a full JSON representation of a list of content
STATUS 204 NO CONTENT - application/json Returns a full JSON representation of a list of content
STATUS 400 BAD REQUEST - application/json Returns a full JSON representation of a list of content
STATUS 401 NAUTHORIZED - application/json Returns a full JSON representation of a list of content
STATUS 403 FORBIDDEN - application/json Returns a full JSON representation of a list of content
STATUS 404 NOT FOUND - application/json Returns a full JSON representation of a list of content
STATUS 405 METHOD NOT ALLOWED - application/json Returns a full JSON representation of a list of content
STATUS 406 Not Acceptable - application/json Returns a full JSON representation of a list of content
STATUS 409 CONFLICT - application/json Returns a full JSON representation of a list of content
STATUS 500 INTERNAL SERVER ERROR - application/json Returns a full JSON representation of a list of content
STATUS 503 Service Unavailable - application/json Returns a full JSON representation of a list of content

복수 수신자 메일 발송 등록

POST https://api.apibus.co.kr/mailsend/multi

Request

QUERY PARAMETERS

parameter		type	description

parameter		type	description
`mailId`		string	메일 아이디: 유니크한 값이여야 합니다.
tid		int	서비스코드	saas.bizisolution.co.kr에 실시간메일>서비스에 등록한 서비스코드를 입력한다.
`sname`		string	보내는 사람 이름	서비스에 보내는 사람이름을 세팅했다면 입력하지 않아도 됨
`smail`		string	보내는 사람 이메일주소	서비스에 보내는 사람 이메일주소를 세팅했다면 입력하지 않아도 됨
`subject`		string	메일제목	서비스에 메일제목을 세팅했다면 입력하지 않아도 됨
`contents`		string	메일내용	서비스에 메일내용을 세팅했다면 입력하지 않아도 됨
`cdate`		string	메일 발송 예약 일자
`status`		string	메일 예약 상태
`charset`		string	사용할 charset
`targetList`	`rname`	string	받는 사람 이름	받는 사람 정보를 array 하여 입력한다.
	`rmail`	string	받는 사람 이메일주소
`addfield`		string	머지필드

Responses

STATUS 200 OK - application/json Returns a full JSON representation of a list of content
STATUS 201 Created - application/json Returns a full JSON representation of a list of content
EXAMPLE
STATUS 202 Accepted - application/json Returns a full JSON representation of a list of content
STATUS 204 NO CONTENT - application/json Returns a full JSON representation of a list of content
STATUS 400 BAD REQUEST - application/json Returns a full JSON representation of a list of content
STATUS 401 NAUTHORIZED - application/json Returns a full JSON representation of a list of content
STATUS 403 FORBIDDEN - application/json Returns a full JSON representation of a list of content
STATUS 404 NOT FOUND - application/json Returns a full JSON representation of a list of content
STATUS 405 METHOD NOT ALLOWED - application/json Returns a full JSON representation of a list of content
STATUS 406 Not Acceptable - application/json Returns a full JSON representation of a list of content
STATUS 409 CONFLICT - application/json Returns a full JSON representation of a list of content
STATUS 500 INTERNAL SERVER ERROR - application/json Returns a full JSON representation of a list of content
STATUS 503 Service Unavailable - application/json Returns a full JSON representation of a list of content

메일 발송 결과 조회

GET https://api.apibus.co.kr/mailsend/result/{mailId}

Request

QUERY PARAMETERS

parameter	type	description

parameter	type	description
`mailId`	string	메일 아이디: 조회하고자 하는 메일 아이디

Responses

STATUS 200 OK - application/json Returns a full JSON representation of a list of content
EXAMPLE
STATUS 400 BAD REQUEST - application/json Returns a full JSON representation of a list of content
STATUS 401 NAUTHORIZED - application/json Returns a full JSON representation of a list of content
STATUS 403 FORBIDDEN - application/json Returns a full JSON representation of a list of content
STATUS 404 NOT FOUND - application/json Returns a full JSON representation of a list of content
STATUS 405 METHOD NOT ALLOWED - application/json Returns a full JSON representation of a list of content
STATUS 406 Not Acceptable - application/json Returns a full JSON representation of a list of content
STATUS 409 CONFLICT - application/json Returns a full JSON representation of a list of content
STATUS 500 INTERNAL SERVER ERROR - application/json Returns a full JSON representation of a list of content
STATUS 503 Service Unavailable - application/json Returns a full JSON representation of a list of content

메일 정보 삭제

DELETE https://api.apibus.co.kr/mailsend/{mailId}

Request

QUERY PARAMETERS

parameter	type	description

parameter	type	description
`mailId`	string	메일 아이디: 삭제하고자 하는 메일 아이디

Responses

STATUS 200 OK - application/json Returns a full JSON representation of a list of content
EXAMPLE
STATUS 400 BAD REQUEST - application/json Returns a full JSON representation of a list of content
STATUS 401 NAUTHORIZED - application/json Returns a full JSON representation of a list of content
STATUS 403 FORBIDDEN - application/json Returns a full JSON representation of a list of content
STATUS 404 NOT FOUND - application/json Returns a full JSON representation of a list of content
STATUS 405 METHOD NOT ALLOWED - application/json Returns a full JSON representation of a list of content
STATUS 406 Not Acceptable - application/json Returns a full JSON representation of a list of content
STATUS 409 CONFLICT - application/json Returns a full JSON representation of a list of content
STATUS 500 INTERNAL SERVER ERROR - application/json Returns a full JSON representation of a list of content
STATUS 503 Service Unavailable - application/json Returns a full JSON representation of a list of content

메일 발송 정보 조회

GET https://api.apibus.co.kr/mailsend/{mailId}

Request

QUERY PARAMETERS

parameter	type	description

parameter	type	description
`mailId`	string	메일 아이디: 조회하고자 하는 메일 아이디

Responses

STATUS 200 OK - application/json Returns a full JSON representation of a list of content
EXAMPLE
STATUS 400 BAD REQUEST - application/json Returns a full JSON representation of a list of content
STATUS 401 NAUTHORIZED - application/json Returns a full JSON representation of a list of content
STATUS 403 FORBIDDEN - application/json Returns a full JSON representation of a list of content
STATUS 404 NOT FOUND - application/json Returns a full JSON representation of a list of content
STATUS 405 METHOD NOT ALLOWED - application/json Returns a full JSON representation of a list of content
STATUS 406 Not Acceptable - application/json Returns a full JSON representation of a list of content
STATUS 409 CONFLICT - application/json Returns a full JSON representation of a list of content
STATUS 500 INTERNAL SERVER ERROR - application/json Returns a full JSON representation of a list of content
STATUS 503 Service Unavailable - application/json Returns a full JSON representation of a list of content

java api 다운로드

	파일	변경됨
레이블 레이블 없음 Preview 보기	ZIP 보관 java_api.zip	8월 18, 2021 by 이건석 (Unlicensed)

기술지원 : TEL(고객센터 : 02-3406-9380), E-Mail(bizenicsass@bizisolution.co.kr)