API
JamCloud API를 사용하면 스크립트, 스프레드시트 또는 다른 앱이 워크스페이스를 읽고 변경할 수 있습니다. 트랙 목록 보기, 파일 가져오기, 섹션과 코드 차트 가져오기 등이 가능합니다. API는 내가 속한 각 워크스페이스에서 내가 보는 것과 똑같은 것을 봅니다.
API 키
섹션 제목: “API 키”개인 키(jc_로 시작)는 API에서 나를 대신합니다. 모든 계정에 키가 포함되지는 않으며, 관리자가 액세스를 부여할 수 있습니다. 권한이 없으면 설정 › API 키에 계정에 API 액세스가 포함되어 있지 않다고 표시됩니다.
설정 › API 키에서 키 이름을 정하고 다음을 고르세요.
- 읽기 전용: 읽기만 하고 아무것도 변경하지 않습니다.
- 읽기 및 쓰기: 가져오기, 편집, 삭제도 할 수 있습니다. 각 워크스페이스에서 내 역할의 범위 안에서만 가능합니다.
- 만료: 만료 없음, 또는 30일, 90일, 365일 후.
키는 키 만들기 직후 한 번만 표시됩니다. 복사해서 비밀번호처럼 안전한 곳에 보관하세요. 이후 목록에는 키의 앞부분, 마지막 사용일, 만료일만 표시됩니다. 취소하면 키가 즉시 멈춥니다. 활성 키는 10개까지 가질 수 있습니다.
호출해 보기
섹션 제목: “호출해 보기”키를 Authorization 헤더에 담아 보내세요.
curl -H "Authorization: Bearer jc_…" https://api-jamcloud.australfactory.cl/api/v1/groups이 호출은 워크스페이스 목록을 반환합니다. 대부분의 다른 경로는 워크스페이스 아래에 있습니다(/api/v1/groups/<id>/…).
키로 할 수 없는 일
섹션 제목: “키로 할 수 없는 일”키는 계정에 절대 닿지 않습니다. 로그인, 프로필, 보안, 알림, 다른 API 키, 관리(/auth, /me, /admin, /realtime, /api-keys)는 api_key_forbidden 코드와 함께 403을 반환합니다. 이런 것은 앱에서 관리하세요. 읽기 전용 키로 무언가를 변경하려고 하면 403 api_key_read_only를 받습니다.
API가 일시적으로 중지되면 키를 사용한 모든 호출이 503 circuit_open을 받습니다. Retry-After 헤더에 적힌 초만큼 기다린 뒤 다시 시도하세요. 앱 자체는 계속 작동합니다.
API 레퍼런스
섹션 제목: “API 레퍼런스”API 레퍼런스(버전 1)에는 키로 호출할 수 있는 모든 경로가 매개변수, 필드, 바로 실행할 수 있는 예시와 함께 나와 있습니다.