- 인터페이스
- REST 및 JSON
- 인증
- 환경별로 API 키 한 세트
- 샌드박스
- 스토어 없이 전송 테스트
호출 네 번이면 초안부터 정산서까지
API는 대시보드에서 릴리스가 거치는 과정을 그대로 따릅니다. 릴리스를 만들고, 전송하고, 들어오는 수치를 읽고, 정산서를 조회합니다. 호출을 선택하면 보내는 값과 돌아오는 응답을 볼 수 있습니다.
- 요청과 응답은 모두 JSON입니다
- 오류는 실패한 필드와 이유를 알려 줍니다
- 샌드박스와 운영 환경에서 같은 호출이 동작합니다
Engine API
요청 예시POST/v1/releases
요청 본문
{ "title": "Night Drive", "artist": "Mira Kaya", "label": "Northfield Audio", "release_date": "2027-03-12"}응답
{ "id": "rel_8f2k1", "status": "draft", "upc": null}엔드포인트 주변에 갖춰진 기능
호출 자체는 연동에서 가장 짧은 부분입니다. 아무도 지켜보지 않을 때도 연동이 계속 동작하게 하는 것은 아래의 기능들입니다.
- 웹훅
- 전송 상태가 바뀌거나, 릴리스가 공개되거나, 정산서가 준비되면 이벤트를 받을 수 있어 폴링할 필요가 없습니다.
- 멱등성 키
- 쓰기 요청에 키를 함께 보내면, 재시도해도 릴리스가 중복 생성되지 않고 첫 번째 결과가 반환됩니다.
- 페이지 나누기
- 목록은 커서를 반환합니다. 이를 다시 전달하면 다음 페이지를 받으며, 순서는 항상 같습니다.
- 샌드박스
- 별도 키를 가진 독립된 환경입니다. 전송이 처음부터 끝까지 실행되지만 스토어에는 도달하지 않고 멈춥니다.
- 버전 관리
- 버전은 경로에 포함됩니다. 호환되지 않는 변경은 새 버전으로 배포되므로, 기존에 연동한 버전은 그대로 유지됩니다.
- 요청 한도
- 모든 응답에 남은 허용량이 표시되며, 한도에 걸린 요청에는 다시 시도할 시점이 안내됩니다.
첫 키 발급부터 실제 전송까지
- 1
키 발급받기
계정을 신청하세요. 승인되면 샌드박스 키를 만드세요.
- 2
샌드박스에서 개발
연동이 모든 상태를 처리할 때까지 릴리스를 만들고 테스트 전송을 실행하세요.
- 3
운영 환경 접근 요청
무엇을 만들고 계신지 알려 주세요. 검토 후 운영 키를 발급해 드립니다.
- 4
전송
운영 키로 바꾸면 같은 호출이 실제 스토어에 도달합니다.
Engine FAQ
아니요. 레퍼런스는 공개되어 있습니다. 신청을 통해 개설되는 계정은 키가 필요할 때에만 있으면 됩니다.
네. API로 만든 릴리스는 대시보드에 나타나고, 대시보드에서 만든 릴리스는 API로 조회하고 전송할 수 있습니다.
실제 전송과 같은 상태를 거치고 같은 웹훅이 발송되지만, 스토어로는 아무것도 전송되지 않습니다.