개발가이드
API 레퍼런스
엔드포인트별 파라미터·응답 필드·오류 코드의 정본이에요.
이 가이드는 연동 규약과 흐름을 다루고, 필드 단위 정의는 API 레퍼런스가 정본이에요. 두 문서가 다르면 레퍼런스가 맞아요.
레퍼런스는 별도 인증 없이 열람할 수 있어요. 키를 받기 전에도 미리 읽어볼 수 있어요.
실서비스 환경
| 문서 | 주소 |
|---|---|
| ReDoc (읽기용) | https://admin-api.vurity.kr/open/v1/redoc |
| Swagger UI (브라우저에서 호출) | https://admin-api.vurity.kr/open/v1/docs |
| OpenAPI 스키마 (코드 생성용) | https://admin-api.vurity.kr/open/v1/openapi.json |
개발(dev) 환경
| 문서 | 주소 |
|---|---|
| ReDoc (읽기용) | https://admin-api-dev.vurity.kr/open/v1/redoc |
| Swagger UI (브라우저에서 호출) | https://admin-api-dev.vurity.kr/open/v1/docs |
| OpenAPI 스키마 (코드 생성용) | https://admin-api-dev.vurity.kr/open/v1/openapi.json |
이렇게 쓰면 좋아요
- ReDoc은 3단 레이아웃이라 통째로 읽어 내려가기 좋아요. 전체 오류 코드 목록도 문서 상단에 있어요.
- Swagger UI는 브라우저에서 직접 호출해 볼 수 있어요.
vpk_test_키로 dev에서 시험하는 데 적합해요. - OpenAPI 스키마는 클라이언트 코드 생성기에 넣어 쓸 수 있어요.
키는 환경별로 달라요
dev 문서에는 vpk_test_ 키를, 실서비스 문서에는 vpk_live_ 키를 써요. 환경이 맞지 않으면 401 INVALID_API_KEY로 거절돼요.