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_b2b_business_infos`(*, brn_list)	사업자등록 정보조회
`get_b2b_business_infos_async`(*, brn_list)	사업자등록 정보조회
`get_platform_company_state`(*, ...[, test])	사업자 조회
`get_platform_company_state_async`(*, ...[, test])	사업자 조회

get_b2b_business_infos(*, brn_list: list[str]) → GetB2bBusinessInfosResponse#

사업자등록 정보조회

요청된 사업자등록번호 리스트에 해당하는 사업자등록 정보를 조회합니다. 해당 API 사용을 위해서는 별도 문의가 필요합니다.

Parameters:

brn_list (list[str]) – 조회할 사업자등록번호 리스트

Raises:

async get_b2b_business_infos_async(*, brn_list: list[str]) → GetB2bBusinessInfosResponse#

사업자등록 정보조회

요청된 사업자등록번호 리스트에 해당하는 사업자등록 정보를 조회합니다. 해당 API 사용을 위해서는 별도 문의가 필요합니다.

Parameters:

brn_list (list[str]) – 조회할 사업자등록번호 리스트

Raises:

get_platform_company_state(*, business_registration_number: str, test: bool | None = None) → GetPlatformCompanyStatePayload#

사업자 조회

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

Parameters:

business_registration_number (str) – 사업자등록번호
test (bool, optional) –
테스트 모드 여부

테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.

Raises:

async get_platform_company_state_async(*, business_registration_number: str, test: bool | None = None) → GetPlatformCompanyStatePayload#

사업자 조회

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

Parameters:

business_registration_number (str) – 사업자등록번호
test (bool, optional) –
테스트 모드 여부

테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.

Raises:

portone_server_sdk.CompanyClient