Apple Business에서 웹훅 설정
API 액세스 권한이 있는 타사 파트너는 웹훅 을 사용하여 다양한 리소스 및 이벤트와 관련된 상태 변경의 푸시 알림을 받을 수 있습니다. 웹훅을 사용하여 사용할 수 있는 알림 유형은 알림 API에서 사용할 수 있는 알림 유형과 일치합니다.
참고: “웹훅”을 사용하려면 Apple Business에 대한 API 액세스 권한이 있어야 하며, 각 환경에 대해 Apple의 승인을 받아야 합니다. API 액세스 권한 요청을 참고하십시오.
첫 웹훅 생성
Apple Business에서 “조직 책임자” 또는 마케팅 책임자 역할을 가진 사용자로 로그인합니다.
역할 및 권한을 확인하려면 역할 및 권한 소개(Intro to roles and permissions)를 확인하십시오.
API를 선택합니다.
“웹훅 추가” 옆에 있는
을 선택한 후, 다음 정보를 입력합니다.정보
설명
웹훅
다음 기호를 제외한 문자, 숫자, 기호를 포함할 수 있습니다.
; (세미콜론)
’ (아포스트로피)
[ (왼쪽 대괄호)
] (오른쪽 대괄호)
< (보다 작음 기호)
> (보다 큼 기호)
팀원
연결에 실패할 경우 연락하는 “조직체 관리자” 또는 “마케팅 관리자” 역할의 사용자입니다.
환경
제한 사항:
“웹훅”을 설정한 후에는 환경을 변경할 수 없습니다.
이벤트는 환경당 한 번만 사용할 수 있습니다.
페이로드 URL
https://로 시작해야 합니다.
이벤트
리소스나 기타 이벤트를 하나 이상 선택해야 합니다.
참고: “저장”을 선택하면 연결을 확인하기 위해 ping이 URL에 전송됩니다.
“저장”을 선택합니다.
“복사”를 선택하여 클라이언트 암호를 “클립보드(Clipboard)”에 복사합니다.
해당 클라이언트 암호를 “웹훅” 책임자와 공유합니다.
책임자가 클라이언트 시크릿을 정상적으로 수신했는지 확인한 후, "완료"를 선택합니다.
웹훅 편집
Apple Business에서 “조직 책임자” 또는 마케팅 책임자 역할을 가진 사용자로 로그인합니다.
역할 및 권한을 확인하려면 역할 및 권한 소개(Intro to roles and permissions)를 확인하십시오.
API를 선택합니다.
“웹훅 관리” 옆에 있는
선택 후, 목록에서 편집할 “웹훅”을 선택합니다.다음을 변경할 수 있습니다.
웹훅 이름
웹훅 상태
연결 실패 시 연락할 팀원의 이름
페이로드 URL
필요한 경우 “새로운 클라이언트 시크릿 생성”을 선택한 다음, “생성”을 선택합니다.
참고: 클라이언트 암호는 세션이 종료된 후에는 검색할 수 없는 일회용 자격 증명이므로 수동으로 공유하고 확인해야 합니다.
해당 클라이언트 암호를 “웹훅” 책임자와 공유합니다.
조직체 관리자가 클라이언트 암호를 받았음을 확인한 다음 “완료”를 선택합니다.
알림을 받을 리소스 및 이벤트를 모두 선택합니다.
참고: 동일한 “웹훅” 환경에서 사용하는 리소스는 여러 “웹훅”에서 중복으로 사용할 수 없습니다.
“저장”을 선택합니다.
웹훅 상태 확인 및 변경
Apple Business에서 “조직 책임자” 또는 마케팅 책임자 역할을 가진 사용자로 로그인합니다.
역할 및 권한을 확인하려면 역할 및 권한 소개(Intro to roles and permissions)를 확인하십시오.
API를 선택합니다.
웹훅 관리 옆에 있는
선택 후, 웹훅 목록을 확인합니다.웹훅의 상태를 변경하여 켜거나 끕니다.
“웹훅”을 끄면 해당 “웹훅”으로의 알림 전송이 중단됩니다.
웹훅 삭제
Apple Business에서 “조직 책임자” 또는 마케팅 책임자 역할을 가진 사용자로 로그인합니다.
역할 및 권한을 확인하려면 역할 및 권한 소개(Intro to roles and permissions)를 확인하십시오.
API를 선택합니다.
웹훅 관리 옆에 있는
선택 후, 웹훅 목록을 확인합니다.“웹훅”을 선택하고 아래로 스크롤하여 “웹훅 삭제”를 선택합니다.
“삭제”를 선택한 다음 “저장”을 선택합니다.