관리 API OpenAPI 스키마
클라이언트와 타입 생성에 사용하는 OpenAPI JSON
월별 사용량과 유닛 잔액 조회를 포함한 OpenAPI 3.1 스키마의 주소, 제공 범위와 도구 연결 방법을 안내합니다.
페이지 목차
관리 API OpenAPI 스키마에 포함되는 정보
문서용 OpenAPI JSON에는 월별 사용량 조회와 유닛 잔액 조회의 정의와 두 조회에 필요한 스키마만 포함됩니다. 각 조회의 HTTP 메서드, 경로, 기본 URL, 인증 방식, 파라미터, 응답 상태와 필드 구조를 확인할 수 있습니다. 이 파일을 근거로 다른 API 경로도 지원된다고 추정하지 마세요.
이 JSON으로 클라이언트나 타입을 생성하거나, 스키마를 검사하거나, Postman 같은 API 도구로 가져올 수 있습니다. 실제 API 요청을 구성하거나 오류를 해결할 때는 월별 사용량 또는 유닛 잔액의 조건과 예시도 확인하세요.
JSON 가져오기
문서용 OpenAPI JSON은 다음 주소에서 확인할 수 있습니다.
https://docs.platform.letsur.ai/api/platform-openapi파일로 다운로드하려면 다음과 같이 요청합니다.
curl --output letsur-platform-openapi.json \
'https://docs.platform.letsur.ai/api/platform-openapi'도구에 연결할 때
문서용 JSON에는 실제 관리 API 키, 스페이스 식별자, 사용량, 잔액이나 계정 데이터가 포함되지 않습니다. 외부 도구가 스키마를 저장할 수 있으므로 조직에서 승인한 도구에만 연결하세요.
JSON을 다운로드해 클라이언트나 타입을 생성할 때는 관리 API 키가 필요하지 않습니다.
- 클라이언트와 타입을 생성하기 전에 사용하는 도구가 OpenAPI 3.1을 지원하는지 확인합니다.
- Postman이나 API 검사 도구에는 문서용 JSON 주소를 입력하고, 가져온 요청의 HTTP 메서드와 기본 URL을 다시 확인합니다.
- 생성한 클라이언트로 실제 API를 호출할 때는 관리 API 키 인증을 적용합니다.
- 생성 결과가 개별 엔드포인트 문서와 다르면 JSON을 다시 다운로드해
info.version과 차이가 있는 필드를 확인합니다.
업데이트와 검증본
엔드포인트 문서 상단에 마지막 검증본 안내가 보이면 문서 사이트가 최신 스키마를 확인하지 못해 저장해 둔 검증본을 보여 주고 있다는 뜻입니다. 이때도 표시된 버전의 JSON을 다운로드할 수 있습니다.
실제 응답과 문서가 다르면 표시된 버전과 HTTP 메서드, 경로 및 차이가 있는 필드를 확인하세요. JSON을 다시 다운로드해도 차이가 있으면 로그인 뒤 플랫폼 내 문의 기능에 이 정보를 남깁니다. 실제 관리 API 키나 계정의 사용량, 잔액 데이터는 보내지 마세요.