개요
OOZOO PAY API의 주요 기능과 연동 순서를 안내합니다.
OOZOO PAY API 기능 개요
OOZOO PAY는 가맹점이 암호화폐 결제를 간편하게 연동할 수 있도록 REST API와 JavaScript SDK를 제공합니다.
- 결제 API: 인보이스 생성 및 조회를 통한 암호화폐 결제 처리
- 출금 API: 프로젝트 잔고에서 외부 지갑으로 출금 요청 및 조회
- 웹훅: 결제 완료 이벤트를 실시간으로 수신
- SDK: 프론트엔드에서 결제 UI를 손쉽게 표시
API 연동 방식
| 항목 | 설명 |
|---|---|
| 프로토콜 | HTTPS (TLS 1.2 이상) |
| 데이터 형식 | JSON (application/json; charset=utf-8) |
| 인증 방식 | HMAC-SHA256 서명 |
API 기능 목록
| 분류 | 기능 | Method | Path |
|---|---|---|---|
| 결제 | 인보이스 생성 | POST | /api/invoices |
| 결제 | 인보이스 목록 조회 | GET | /api/invoices |
| 결제 | 인보이스 조회 | GET | /api/invoices/{invoiceId} |
| 출금 | 출금 요청 생성 | POST | /api/invoices/withdrawals |
| 출금 | 출금 목록 조회 | GET | /api/invoices/withdrawals |
| 출금 | 출금 상세 조회 | GET | /api/invoices/withdrawals/{withdrawalId} |
Endpoint
https://api.oozoopay.com
모든 API 요청의 Base URL입니다. 전체 요청 URL은 Base URL에 API 경로를 결합하여 구성합니다.
https://api.oozoopay.com/api/invoices
API Key 발급
API 연동을 위해 OOZOO PAY 가맹점 대시보드에서 API Key를 발급받아야 합니다.
- 대시보드에 로그인합니다.
- 프로젝트 선택 → Developers → API Keys 메뉴로 이동합니다.
- 새 API Key 생성을 클릭합니다.
- 발급된 Client Key(
pk_)와 Secret Key(sk_)를 안전하게 보관합니다.
Secret Key 보관
Secret Key는 생성 시 한 번만 표시됩니다. 분실 시 새로 발급받아야 하며, 외부에 노출되지 않도록 반드시 서버 사이드에서만 사용해야 합니다.
테스트 환경
OOZOO PAY는 별도의 샌드박스 환경을 제공하지 않습니다. 테스트가 필요한 경우 대시보드에서 테스트 모드 프로젝트를 생성하여 블록체인 테스트넷 환경에서 연동을 검증할 수 있습니 다.
| 모드 | 블록체인 네트워크 | 비고 |
|---|---|---|
| 테스트 | 테스트넷 (Sepolia 등) | - |
| 라이브 | 메인넷 (Ethereum 등) | - |
API Key 형식은 모드에 관계없이 동일하며(pk_, sk_), 프로젝트의 모드 설정에 따라 연결되는 블록체인 네트워크가 달라집니다.
팁
테스트 모드에서 충분히 연동 테스트를 완료한 뒤 라이브 모드 프로젝트로 전환하시기 바랍니다.
연동 순서
일반적인 연동 순서는 다음과 같습니다.