고객센터

    [자동메일 API Json] API 연동메일 호출 테스트 예시_json형식
    • 작성일2023/02/28 14:10
    • 조회 1,880

    프링고 자동메일 API 연동 방식 중 JSON형식 연동 API 호출 테스트 예시입니다.

     

    1. 연동 URL  : method와 Endpoint 연동 URL을 입력합니다.

    ● v.3.1.1 버전 연동 정보
    - method : POST
    - Endpoint URL : https://[서버-도메인-입력]/api/event/v1/send
    - Content : JSON (application/json)

    ● v.3.2 버전 연동 정보
    - method : POST
    - Endpoint URL : https://[서버-도메인-입력]/api/event/v2/json-send
    - Content : JSON (application/json)

     

    2. JSON 연동데이터 입력 (예시)

    ● 예시 값 (JSON 형식)

    {
    "api_key" : "26b5e58f33cdd005",
    "template_id" : "11",
    "sender" : "help@pringo.co.kr",
    "sender_name" : "프링고 고객센터",
    "recipient_name" : "홍길동",
    "recipient" : "gildong@company.co.kr",
    "name" : "홍길동",
    "mem_id" : "abc01234",
    "join_date_time" : "2022-06-23 14:20",
    "join_key" : "elfmvfc7dfvnmcncv"
    }

     

    ● 연동 치환코드 입력 값

    전송 파라미터 설명 Value값 (예시)
    api_key (필수) 계정관리 - API용 KEY를 그대로 입력 dfd6fd9fsdfbjdnfkd38fndjfd023
    template_id (필수) 연동 발송할 메일의 템플릿 key (숫자만 입력) 8
    sender 발신 이메일 주소 alert@pringo.co.kr
    sender_name 발신자명 (보내는 사람 이름) 프링고 고객센터
    recipient 수신 이메일 주소 gildong@naver.com
    recipient_name 수신자명 (받는 사람 이름) 홍길동님
    subject (필수) 메일 제목 '보유 포인트 유효기간 안내'
    body (필수) 메일 내용 '[[$user_id]]님께서 보유하신 포인트~'

    사용자 정의 변수

    메일 치환 변수명을 지정하여 JSON 배열로 입력
    (시스템 변수인 email은 변수명 지정 불가)

     

     

    3. API 호출 및 호출 결과값을 확인합니다. 

    • 연동 방식 및 각 파라미터의 내용이 모두 잘 기입 되었는지 확인 하신 뒤, Send 버튼을 클릭하시면 API 호출이 요청됩니다.
    • API 호출 후 오른쪽 화면에 호출 결과값이 보여집니다. result가 숫자 1로 보이면 호출이 성공되었음을 의미합니다.
        (API 호출이 성공이 된 것이지, 발송이 성공 된 것은 아닙니다.)

          

    4. API 호출 Response 결과 리턴코드