서버 SDK 레퍼런스

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

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

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

JavaScript 및 TypeScript

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

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

애플리케이션 코드 시작 부분에 아래 코드를 삽입해 주세요.

CommonJS
globalThis.crypto = require("node:crypto").webcrypto;

ESM
import { webcrypto } from "node:crypto";
globalThis.crypto = webcrypto;

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

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

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

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

Apache Maven
<dependency>
    <groupId>io.portone</groupId>
    <artifactId>server-sdk</artifactId>
    <version>0.3.0</version>
</dependency>

Gradle (Kotlin)
implementation("io.portone:server-sdk:0.3.0")

Gradle (Groovy)
implementation 'io.portone:server-sdk:0.3.0'

sbt
libraryDependencies += "io.portone" % "server-sdk" % "0.3.0"