4장. Webhook를 사용한 3scale 자동화

Webhook는 자동화를 용이하게 하는 기능이며 3scale에서 발생하는 이벤트를 기반으로 다른 시스템을 통합하는 데에도 사용됩니다. 3scale 시스템 내에서 지정된 이벤트가 발생하면 웹 후크 메시지와 함께 애플리케이션에 알림이 표시됩니다. 예를 들어 Webhook를 구성하면 새 계정 등록의 데이터를 사용하여 개발자 포털을 채울 수 있습니다.

4.1. Webhook 개요

Webhook는 Webhooks 구성 창에서 사용할 수 있는 이벤트에서 선택한 이벤트에 의해 트리거되는 사용자 정의 HTTP 콜백입니다. 이러한 이벤트 중 하나가 발생하면 3scale 시스템은 Webhook 섹션에 지정된 URL 주소에 대한 HTTP 또는 HTTPS 요청을 수행합니다. Webhook를 사용하면 이벤트 추적과 같은 몇 가지 원하는 동작을 호출하도록 리스너를 구성할 수 있습니다.

웹 후크의 형식은 항상 동일합니다. 다음 구조의 XML 문서를 사용하여 끝점에 게시를 만듭니다. 

<?xml version="1.0" encoding="UTF-8"?>
<event>
  <type>application</type>
  <action>updated</action>
  <object>
    THE APPLICATION OBJECT AS WOULD BE RETURNED BY A GET ON THE ACCOUNT MANAGEMENT
    API
  </object>
</event>

각 요소는 정보를 제공합니다.

  • <type>: 애플리케이션,계정 등 이벤트의 주체를 제공합니다.
  • & lt;action&gt; : updated,created,deleted.와 같은 값을 사용하여 수행된 항목을 지정합니다.
  • <object>: 계정 관리 API에서 반환하는 것과 동일한 형식으로 XML 오브젝트 자체를 구성합니다. 이를 확인하려면 대화형 ActiveDocs를 사용할 수 있습니다.

Webhook가 3scale에서 발행했음을 보장해야 하는 경우 HTTPS 웹 후크 URL을 노출하고 3scale의 Webhook 선언에 사용자 정의 매개변수를 추가합니다. 예: https://your-webhook-endpoint?someSecretParameterName=someSecretParameterValue. 매개변수 이름과 값을 결정합니다. 그런 다음 웹 후크 끝점 내부에서 이 매개변수 값이 있는지 확인합니다.