API 만들기

<도구 | API> 메뉴에서 “NEWSLETTER” 유형 API를 만듭니다.

API 요청

GET 형식으로 요청해야 합니다.

/r/api/${uuid}?action=NEWSLETTER_GET&email=${email}

URL 파라미터
이름	유형	설명	필수 여부	예
uuid	UUID	API UUID	예	5b969d63e97cfec7
action	문자열	작업 유형	예	NEWSLETTER_GET
email	문자열	구독자 이메일. 최대 320자	예	dimdol@3rabbitz.com

구독자를 가져오는 예제입니다.

/r/api/5b969d63e97cfec7?action=NEWSLETTER_GET&email=support@3rabbitz.com

다음을 참고합니다.

이메일은 앞뒤 공백을 없애고 소문자로 바꾸어 찾습니다. 따라서 대소문자만 다르게 입력해도 같은 구독자를 가져옵니다.
구독 상태와 상관없이 가져옵니다. 구독을 취소한 구독자는 status 값이 UNSUBSCRIBED입니다.

이메일을 URL에 담아 보내므로 웹 서버와 프록시의 접근 기록에 이메일이 남습니다. 접근 기록을 보관하는 기간과 범위를 함께 확인합니다.

API 응답

`NEWSLETTER_GET` 응답

JSON 형식의 응답은 다음과 같습니다.

`NEWSLETTER_GET` 응답
이름	유형	설명	필수 여부	예
status	문자열	상태	예	success \| fail
subscriber	구독자 객체	구독자 데이터	아니오
errors	Error 객체 배열	예외	아니오

응답에 포함하는 구독자 객체는 구독자 객체를 참고합니다.

예외 항목

예외 항목은 다음과 같습니다.

NEWSLETTER_GET 예외 항목
예외	설명
INVALID_EMAIL	이메일 형식이 맞지 않을 때
INVALID_PARAMETER	문자열의 길이가 형식에 맞지 않을 때
NEWSLETTER_SUBSCRIBER_NOT_EXIST	해당 이메일의 구독자가 없을 때
REQUIRED_PARAMETER_MISSING	API 요청에 필수 항목이 없을 때

예제

예제입니다.

{
    "status": "success",
    "subscriber": {
        "id": "5b969d63e97cfec7",
        "email": "support@3rabbitz.com",
        "name": "쓰리래빗츠",
        "status": "SUBSCRIBED",
        "createTime": 1785203527087,
        "updateTime": 1785203527087
    }
}

API 만들기

API 요청

API 응답

NEWSLETTER_GET 응답

예외 항목

예제

`NEWSLETTER_GET` 응답