A2: 외부 채널 가이드

외부 채널이란?

외부 채널은 A2와 실제 리테일 플랫폼 사이의 연동을 위한 것입니다. 외부 채널은 webhook 과 비슷하게 동작하며, 리테일 플랫폼의 특정 데이터를 요청할 때 사용됩니다.

예)

  • 광고주의 예산 충전시 결제 페이지 연동
  • 광고주의 예산 환불 요청 페이지 연동

외부 채널을 통해 A2와 리테일 플랫폼이 연동될 때에는 각 용도에 따라 정해진 데이터 형식을 사용하게 됩니다.
개별 시나리오에 대한 자세한 내용은 아래에서 확인할 수 있습니다.

외부 채널 사용 가이드

결제 요청

광고주가 예산 관리 메뉴를 통해 예산을 충전하기로 하였다면 A2는 리테일 플랫폼에게 해당 광고주를 위한 결제페이지의 URL를 등록된 외부 채널을 통해 요청합니다. 리테일 플랫폼으로부터 정상적인 응답을 받게 되는 경우 해당 URL의 팝업을 생성하여 리테일 플랫폼의 결제 프로세스를 따를 수 있도록 합니다.

  • 요청 데이터 형식

    {
      'request_type': 'budget_charge_link_info',
      'params': {
        'user_id': 사용자ID
      }
    }
    
  • 응답 데이터 형식

    {
      'url': 리테일_플랫폼의_결제페이지_URL,
      'width': 팝업윈도우의_너비,
      'height': 팝업윈도우의_높이
    }
    

환불 요청

광고주가 예산 관리 메뉴를 통해 예산을 환불하기로 하였다면 A2는 리테일 플랫폼에게 해당 광고주를 위한 환불페이지의 URL를 등록된 외부 채널을 통해 요청합니다. 리테일 플랫폼으로부터 정상적인 응답을 받게 되는 경우 해당 URL의 팝업을 생성하여 리테일 플랫폼의 환불 프로세스를 따를 수 있도록 합니다. 이렇게 함으로서 리테일 플랫폼은 고유의 환불 정책에 따라 환불을 진행할 수 있습니다.

  • 요청 데이터 형식

    {
      'request_type': 'budget_refund_link_info',
      'params': {
        'user_id': 사용자ID
      }
    }
    
    
  • 응답 데이터 형식

    {
      'url': 리테일_플랫폼의_환불페이지_URL,
      'width': 팝업윈도우의_너비,
      'height': 팝업윈도우의_높이
    }