Skip to main content
AltoPocket
개발자

AltoPocket 연동 API

승인된 파트너 플랫폼을 위한 서버 간 연동입니다. 모든 요청은 발급된 키로 서명되며, 승인된 키로 할 수 있는 일은 승인 후 개발자 콘솔에서 확인할 수 있습니다.

이용 방법

승인된 파트너 전용

회사 정보, 담당자, 서버 IP로 신청합니다. 모든 신청은 AltoPocket 운영자가 심사합니다.

기능은 승인 후 안내

승인되면 개발자 콘솔에서 이 키에 부여할 수 있는 권한을 확인하고, 필요한 권한을 사유와 함께 요청합니다.

서명된 서버 간 호출

모든 호출에는 키와 HMAC 서명이 포함되며, 허용 목록에 등록된 서버 IP에서만 받습니다.

가치가 이동하는 작업은 저절로 실행되지 않습니다. AltoPocket 운영자가 승인합니다.

요청 서명 방법

모든 요청에는 API 키(x-api-key), Unix 타임스탬프(X-AP-Timestamp, ±5분 이내), X-AP-Signature 가 필요합니다. 서명은 타임스탬프·HTTP 메서드·쿼리 문자열을 포함한 경로·본문 바이트의 SHA-256 을 줄바꿈으로 이은 문자열에 대한 서명 시크릿 HMAC-SHA256 입니다. 모든 POST 에는 Idempotency-Key 도 필요하며, 허용 목록에 등록된 서버 IP 에서만 호출할 수 있습니다.

Swagger 레퍼런스의 "Try it out" 은 브라우저에서 요청을 서명할 수 있습니다. 샌드박스 키만 사용하고, 라이브 서명 시크릿은 절대 브라우저에 붙여넣지 마세요.

공개 문서에는 서명 방법, 연결 확인, 키 신청만 있습니다. 승인된 파트너는 자신의 권한에 해당하는 전체 문서를 볼 수 있습니다. Swagger 페이지에서 샌드박스 키를 입력하고 “Unlock full docs”를 누르거나, 서버에서 GET /integrations/v1/docs/openapi.json(서명 필요)을 호출하세요.

Swagger에서 테스트하기

Try it out은 브라우저에서 요청마다 서명하므로 요청은 브라우저의 공인 IP에서 나갑니다. 그 IP가 키에 허용되어 있어야 합니다: 운영 서버 IP, 샌드박스 테스터 IP, 또는 AltoPocket 운영자가 클라이언트에 켤 수 있는 샌드박스 “모든 IP 허용” 설정 중 하나. 서명 패널의 “Check my IP”로 API가 보는 IP를 확인할 수 있고, 거부된 호출은 어떤 IP가 거부되었는지 알려 줍니다. 운영 서명 시크릿은 절대 브라우저에 붙여넣지 마세요.

canonical = timestamp + "\n"
          + METHOD + "\n"
          + path_with_query + "\n"
          + hex(sha256(raw_body))

X-AP-Signature = hex(hmac_sha256(secret, canonical))
x-api-key      = apk_…
X-AP-Timestamp = unix seconds (±300 s)
Idempotency-Key = <every POST>

환경

샌드박스

테스트 네트워크(TRON Nile)와 테스트 데이터입니다. 이곳에서 발급된 키는 apk_dev_ 또는 apk_stage_ 로 시작합니다.

  • https://api.devkcw.com/api/v1/integrations/v1

라이브

운영 환경입니다. 키는 apk_live_ 로 시작하며 샌드박스 키와 별도로 발급됩니다.

https://api.altopocket.com/api/v1/integrations/v1

권한은 승인 후에 요청합니다

신청서에서는 권한을 요청하지 않습니다. 키가 승인되어 수령하면, 개발자 콘솔(또는 키로 서명한 GET /integrations/v1/scopes)에서 각 권한으로 할 수 있는 일을 확인하고 필요한 권한을 사유와 함께 요청합니다. 모든 요청은 운영자가 심사합니다.

개발자 콘솔 열기

API 키 신청

계정 없이 신청할 수 있습니다. 회사 정보, 호출할 서버 IP, 구현할 내용을 알려 주세요. 신청서에서는 권한을 요청하지 않습니다. 승인되면 상태 토큰으로 키를 한 번 수령하고, 그 키로 개발자 콘솔에서 필요한 권한을 요청합니다. 모든 신청과 권한 요청은 AltoPocket 운영자가 심사합니다.

국제 형식(+국가번호…) 또는 왼쪽 국가 코드와 함께 국내 번호. 암호화되어 저장됩니다.

443 포트의 https, 공인 호스트만 가능합니다.

공인 IP 또는 /24 이하의 IPv4 대역, 한 줄에 하나씩 최대 20개.

브라우저에서 서명하는 Swagger “Try it out” 호출은 사용자 PC에서 나가므로, 그 PC의 공인 IP가 허용되어야 합니다. 샌드박스(dev/stage)에서만 사용되며 운영 서버에서는 거부됩니다. 서버 IP와 같은 규칙, 최대 10개.

여기서는 권한을 선택하지 않습니다. 승인 후 발급받은 키로 개발자 콘솔에서 요청하세요.

20자 이상.

모든 신청은 AltoPocket 운영자가 검토합니다.

개발자 — 연동 API · AltoPocket