portone_server_sdk.webhook

portone_server_sdk.webhook#

Module Attributes

WebhookVerificationFailureReason

웹훅 검증 실패 사유입니다.

Functions

verify(secret, payload, headers)

웹훅 페이로드를 검증합니다.

Exceptions

WebhookVerificationError

웹훅 검증이 실패했을 경우

InvalidInputError

SDK에 전달한 사용자 입력이 잘못되었을 경우
portone_server_sdk.webhook.WebhookVerificationFailureReason#

웹훅 검증 실패 사유입니다.

WebhookVerificationError.get_message 에 전달하여 에러 메시지를 얻을 수 있습니다.

alias of Literal[‘MISSING_REQUIRED_HEADERS’, ‘NO_MATCHING_SIGNATURE’, ‘INVALID_SIGNATURE’, ‘TIMESTAMP_TOO_OLD’, ‘TIMESTAMP_TOO_NEW’]

exception portone_server_sdk.webhook.WebhookVerificationError#

웹훅 검증이 실패했을 경우

message: str | None#
reason: Literal['MISSING_REQUIRED_HEADERS', 'NO_MATCHING_SIGNATURE', 'INVALID_SIGNATURE', 'TIMESTAMP_TOO_OLD', 'TIMESTAMP_TOO_NEW']#
classmethod get_message(reason: Literal['MISSING_REQUIRED_HEADERS', 'NO_MATCHING_SIGNATURE', 'INVALID_SIGNATURE', 'TIMESTAMP_TOO_OLD', 'TIMESTAMP_TOO_NEW']) → str#

웹훅 검증 실패 사유로부터 에러 메시지를 생성합니다.

Parameters:

reason (WebhookVerificationFailureReason) – 에러 메시지를 생성할 실패 사유.

Returns:

에러 메시지.

Return type:

str

args#
with_traceback()#

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception portone_server_sdk.webhook.InvalidInputError#

SDK에 전달한 사용자 입력이 잘못되었을 경우

message: str | None#
args#
with_traceback()#

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

portone_server_sdk.webhook.verify(secret: str | bytes | bytearray, payload: str, headers: Mapping[str, str]) → None#

웹훅 페이로드를 검증합니다.

Parameters:

  • secret (str | bytes | bytearray) – 웹훅 시크릿

  • payload (str) – 웹훅 페이로드

  • headers (Mapping[str, str]) – 웹훅 요청 시 포함된 헤더

Raises:
Contents