portone_server_sdk.CompanyClient#

class portone_server_sdk.CompanyClient#

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_platform_company_state`(*, ...)	사업자 조회
`get_platform_company_state_async`(*, ...)	사업자 조회

get_platform_company_state(*, business_registration_number: str) → GetPlatformCompanyStatePayload#

사업자 조회

사업자 정보를 조회합니다. 포트원 서비스에 연동 및 등록되지 않은 사업자도 조회 가능합니다.

Parameters:

business_registration_number (str) – 사업자등록번호

Raises:

async get_platform_company_state_async(*, business_registration_number: str) → GetPlatformCompanyStatePayload#

사업자 조회

사업자 정보를 조회합니다. 포트원 서비스에 연동 및 등록되지 않은 사업자도 조회 가능합니다.

Parameters:

business_registration_number (str) – 사업자등록번호

Raises:

portone_server_sdk.CompanyClient