portone_server_sdk.CounterpartyClient

class portone_server_sdk.CounterpartyClient

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 클라이언트를 생성합니다.
create_b2b_counterparty(*[, test, ...])	거래처 생성
create_b2b_counterparty_async(*[, test, ...])	거래처 생성
delete_b2b_counterparty(*, counterparty_id)	거래처 삭제
delete_b2b_counterparty_async(*, counterparty_id)	거래처 삭제
get_b2b_counterparties(*[, test, page, filter])	거래처 검색
get_b2b_counterparties_async(*[, test, ...])	거래처 검색
get_b2b_counterparty(*, counterparty_id[, test])	거래처 조회
get_b2b_counterparty_async(*, counterparty_id)	거래처 조회
get_b2b_counterparty_certificate(*, brn[, test])	인증서 조회
get_b2b_counterparty_certificate_async(*, brn)	인증서 조회
get_b2b_counterparty_certificate_registration_url(*, brn)	사업자 인증서 등록 URL 조회
get_b2b_counterparty_certificate_registration_url_async(*, brn)	사업자 인증서 등록 URL 조회
update_b2b_counterparty(*, counterparty_id)	거래처 정보 수정
update_b2b_counterparty_async(*, counterparty_id)	거래처 정보 수정
validate_b2b_counterparty_certificate(*, brn)	사업자 인증서 유효성 검증
validate_b2b_counterparty_certificate_async(*, brn)	사업자 인증서 유효성 검증

get_b2b_counterparty_certificate_registration_url(*, brn: str, test: bool | None = None) → GetB2bCounterpartyCertificateRegistrationUrlResponse

사업자 인증서 등록 URL 조회

연동 사업자의 인증서를 등록하기 위한 URL을 조회합니다.

Parameters:

• brn (str) – 사업자등록번호

• test (bool, optional) –

  테스트 모드 여부

  true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.

Raises:

• GetB2bCounterpartyCertificateRegistrationUrlError – API 호출이 실패한 경우

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

async get_b2b_counterparty_certificate_registration_url_async(*, brn: str, test: bool | None = None) → GetB2bCounterpartyCertificateRegistrationUrlResponse

사업자 인증서 등록 URL 조회

연동 사업자의 인증서를 등록하기 위한 URL을 조회합니다.

Parameters:

• brn (str) – 사업자등록번호

• test (bool, optional) –

  테스트 모드 여부

  true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.

Raises:

• GetB2bCounterpartyCertificateRegistrationUrlError – API 호출이 실패한 경우

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

validate_b2b_counterparty_certificate(*, brn: str, test: bool | None = None) → ValidateB2bCounterpartyCertificateResponse

사업자 인증서 유효성 검증

연동 사업자가 등록한 인증서의 유효성을 검증합니다.

Parameters:

• brn (str) – 사업자등록번호

• test (bool, optional) –

  테스트 모드 여부

  true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.

Raises:

• ValidateB2bCounterpartyCertificateError – API 호출이 실패한 경우

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

async validate_b2b_counterparty_certificate_async(*, brn: str, test: bool | None = None) → ValidateB2bCounterpartyCertificateResponse

사업자 인증서 유효성 검증

연동 사업자가 등록한 인증서의 유효성을 검증합니다.

Parameters:

• brn (str) – 사업자등록번호

• test (bool, optional) –

  테스트 모드 여부

  true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.

Raises:

• ValidateB2bCounterpartyCertificateError – API 호출이 실패한 경우

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

get_b2b_counterparty_certificate(*, brn: str, test: bool | None = None) → B2bCertificate

인증서 조회

연동 사업자의 인증서를 조회합니다.

Parameters:

• brn (str) – 사업자등록번호

• test (bool, optional) –

  테스트 모드 여부

  true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.

Raises:

• GetB2bCounterpartyCertificateError – API 호출이 실패한 경우

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

async get_b2b_counterparty_certificate_async(*, brn: str, test: bool | None = None) → B2bCertificate

인증서 조회

연동 사업자의 인증서를 조회합니다.

Parameters:

• brn (str) – 사업자등록번호

• test (bool, optional) –

  테스트 모드 여부

  true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.

Raises:

• GetB2bCounterpartyCertificateError – API 호출이 실패한 경우

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

get_b2b_counterparty(*, counterparty_id: str, test: bool | None = None) → B2bCounterparty

거래처 조회

거래처를 조회합니다.

Parameters:

• counterparty_id (str) – 거래처 ID

• test (bool, optional) –

  테스트 모드 여부

  true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.

Raises:

• GetB2bCounterpartyError – API 호출이 실패한 경우

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

async get_b2b_counterparty_async(*, counterparty_id: str, test: bool | None = None) → B2bCounterparty

거래처 조회

거래처를 조회합니다.

Parameters:

• counterparty_id (str) – 거래처 ID

• test (bool, optional) –

  테스트 모드 여부

  true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.

Raises:

• GetB2bCounterpartyError – API 호출이 실패한 경우

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

delete_b2b_counterparty(*, counterparty_id: str, test: bool | None = None) → DeleteB2bCounterpartyResponse

거래처 삭제

거래처를 삭제합니다.

Parameters:

• counterparty_id (str) – 거래처 ID

• test (bool, optional) –

  테스트 모드 여부

  true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.

Raises:

• DeleteB2bCounterpartyError – API 호출이 실패한 경우

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

async delete_b2b_counterparty_async(*, counterparty_id: str, test: bool | None = None) → DeleteB2bCounterpartyResponse

거래처 삭제

거래처를 삭제합니다.

Parameters:

• counterparty_id (str) – 거래처 ID

• test (bool, optional) –

  테스트 모드 여부

  true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.

Raises:

• DeleteB2bCounterpartyError – API 호출이 실패한 경우

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

update_b2b_counterparty(*, counterparty_id: str, test: bool | None = None, counterparty: B2bCounterpartyInput, options: B2bCounterpartyCreateOptions | None = None) → UpdateB2bCounterpartyResponse

거래처 정보 수정

거래처 정보를 수정합니다.

Parameters:

• counterparty_id (str) – 거래처 ID

• test (bool, optional) –

  테스트 모드 여부

  true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.

• counterparty (B2bCounterpartyInput) – 거래처 정보

• options (B2bCounterpartyCreateOptions, optional) –

  확인 옵션

  사업자 정보 및 휴폐업 상태 조회 옵션입니다.

Raises:

• UpdateB2bCounterpartyError – API 호출이 실패한 경우

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

async update_b2b_counterparty_async(*, counterparty_id: str, test: bool | None = None, counterparty: B2bCounterpartyInput, options: B2bCounterpartyCreateOptions | None = None) → UpdateB2bCounterpartyResponse

거래처 정보 수정

거래처 정보를 수정합니다.

Parameters:

• counterparty_id (str) – 거래처 ID

• test (bool, optional) –

  테스트 모드 여부

  true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.

• counterparty (B2bCounterpartyInput) – 거래처 정보

• options (B2bCounterpartyCreateOptions, optional) –

  확인 옵션

  사업자 정보 및 휴폐업 상태 조회 옵션입니다.

Raises:

• UpdateB2bCounterpartyError – API 호출이 실패한 경우

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

get_b2b_counterparties(*, test: bool | None = None, page: PageInput | None = None, filter: B2bCounterpartyFilter | None = None) → GetB2bCounterpartiesResponse

거래처 검색

거래처를 검색합니다.

Parameters:

• test (bool, optional) –

  테스트 모드 여부

  true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.

• page (PageInput, optional) – 페이지 정보

• filter (B2bCounterpartyFilter, optional) – 검색 필터

Raises:

• GetB2bCounterpartiesError – API 호출이 실패한 경우

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

async get_b2b_counterparties_async(*, test: bool | None = None, page: PageInput | None = None, filter: B2bCounterpartyFilter | None = None) → GetB2bCounterpartiesResponse

거래처 검색

거래처를 검색합니다.

Parameters:

• test (bool, optional) –

  테스트 모드 여부

  true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.

• page (PageInput, optional) – 페이지 정보

• filter (B2bCounterpartyFilter, optional) – 검색 필터

Raises:

• GetB2bCounterpartiesError – API 호출이 실패한 경우

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

create_b2b_counterparty(*, test: bool | None = None, counterparty_id: str | None = None, counterparty: B2bCounterpartyInput, options: B2bCounterpartyCreateOptions | None = None) → CreateB2bCounterpartyResponse

거래처 생성

거래처를 생성합니다.

Parameters:

• test (bool, optional) –

  테스트 모드 여부

  true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.

• counterparty_id (str, optional) –

  거래처 아이디

  입력하지 않으면 임의의 ID가 채번됩니다.

• counterparty (B2bCounterpartyInput) – 거래처 정보

• options (B2bCounterpartyCreateOptions, optional) – 거래처 생성 옵션

Raises:

• CreateB2bCounterpartyError – API 호출이 실패한 경우

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

async create_b2b_counterparty_async(*, test: bool | None = None, counterparty_id: str | None = None, counterparty: B2bCounterpartyInput, options: B2bCounterpartyCreateOptions | None = None) → CreateB2bCounterpartyResponse

거래처 생성

거래처를 생성합니다.

Parameters:

• test (bool, optional) –

  테스트 모드 여부

  true 이면 테스트 모드로 실행되며, false 이거나 주어지지 않은 경우 테스트 모드를 사용하지 않습니다.

• counterparty_id (str, optional) –

  거래처 아이디

  입력하지 않으면 임의의 ID가 채번됩니다.

• counterparty (B2bCounterpartyInput) – 거래처 정보

• options (B2bCounterpartyCreateOptions, optional) – 거래처 생성 옵션

Raises:

• CreateB2bCounterpartyError – API 호출이 실패한 경우

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