API 레퍼런스
S/ASH Cloud B2B Partner API 가이드 개요
API 레퍼런스
이 섹션은 개발자/파트너를 위한 기술 레퍼런스예요. 모든 예시는
JSON응답을 기준으로 작성되어 있어요.
Base URL
인증 방식
- 헤더에 API 키를 넣어요.
- 헤더 이름:
X-API-Key
주요 엔드포인트
POST /sessions세션 생성GET /sessions/:id세션 조회DELETE /sessions/:id세션 종료(파기)POST /sessions/:id/pause세션 일시정지POST /sessions/:id/resume세션 재개POST /sessions/:id/launch-url런치 URL 발급GET /docsOpenAPI YAML 조회
응답 규칙
- 성공: 2xx + JSON
- 실패: 적절한 HTTP 코드 + 에러 JSON
상태값
세션 관련 응답에는 상태값이 포함될 수 있어요.
runningpauseddestroyed
빠른 시작
- 1API 키를 발급받아 안전하게 저장하세요.
- 2
POST /sessions로 세션을 생성하세요. - 3
POST /sessions/:id/launch-url로 접속 URL을 생성하세요. - 4필요 시
pause/resume/delete로 수명주기를 관리하세요.