portone_server_sdk.PromotionClient#

class portone_server_sdk.PromotionClient#

Bases: object

__init__(*, secret: str, base_url: str = 'https://api.portone.io', store_id: str | None = None)#

API Secret을 사용해 포트원 API 클라이언트를 생성합니다.

Parameters:
  • secret (str) – 포트원 API Secret입니다.

  • base_url (str, optional) – 포트원 REST API 주소입니다. 기본값은 `https://api.portone.io`입니다.

  • store_id – 하위 상점에 대해 기능을 사용할 때 필요한 하위 상점의 ID입니다.

Methods

__init__(*, secret[, base_url, store_id])

API Secret을 사용해 포트원 API 클라이언트를 생성합니다.

get_promotion(*, promotion_id)

프로모션 단건 조회

get_promotion_async(*, promotion_id)

프로모션 단건 조회

get_promotion(*, promotion_id: str) CardPromotion#

프로모션 단건 조회

주어진 아이디에 대응되는 프로모션을 조회합니다.

Parameters:

promotion_id (str) – 조회할 프로모션 아이디

Raises:
  • GetPromotionError – API 호출이 실패한 경우

  • ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

async get_promotion_async(*, promotion_id: str) CardPromotion#

프로모션 단건 조회

주어진 아이디에 대응되는 프로모션을 조회합니다.

Parameters:

promotion_id (str) – 조회할 프로모션 아이디

Raises:
  • GetPromotionError – API 호출이 실패한 경우

  • ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우