서버 SDK 레퍼런스

웹훅 및 REST API 연동시 사용되는 SDK에 대한 설명 문서입니다.

포트원 서버 SDK는 웹훅을 포함한 포트원 V2 REST API를 여러 언어에서 별도의 보일러플레이트 없이 사용 가능하도록 만들어진 SDK입니다.

현재 JavaScript, Python, JVM을 지원하고 있으며, Go, PHP 등을 지원할 예정입니다.

JavaScript

NPM Version

JSR Version

JavaScript 및 TypeScript에서 사용 가능한 JavaScript SDK는 npm과 jsr을 통해 배포되고 있습니다. @portone/server-sdk 패키지를 의존성에 추가하여 사용하실 수 있습니다.

npm install --save @portone/server-sdk

yarn add @portone/server-sdk

pnpm add @portone/server-sdk

bun add @portone/server-sdk

deno add jsr:@portone/server-sdk

ni @portone/server-sdk

Node.js의 경우 v20 이상에서 정상 동작하며, v20 미만 버전은 폴리필이 필요합니다.

PyPI - Version

Python SDK는 PyPI를 통해 배포되고 있습니다. portone-server-sdk 패키지를 의존성에 추가하여 사용하실 수 있습니다.

uv add portone-server-sdk

poetry add portone-server-sdk

rye add portone-server-sdk

pipenv install portone-server-sdk

conda install portone-server-sdk

pyproject.toml
[project]
dependencies = [
  "portone-server-sdk~=x.x.x"
]

pdm add portone-server-sdk

requirements.txt
portone-server-sdk ~= x.x.x

Python 3.9 이상에서 정상 동작합니다.

Java, Kotlin, Scala 등에서 사용 가능한 JVM SDK는 Maven을 통해 배포되고 있습니다.

io.portone:server-sdk 패키지를 의존성에 추가하여 사용하실 수 있습니다.

<dependency>
  <groupId>io.portone</groupId>
  <artifactId>server-sdk</artifactId>
  <version>x.x.x</version>
</dependency>

implementation("io.portone:server-sdk:x.x.x")

implementation 'io.portone:server-sdk:x.x.x'

libraryDependencies += "io.portone" % "server-sdk" % "x.x.x"