API 요청 규격을 구성하는 요소는 다음과 같습니다.
| 구성 요소 | 설명 |
|---|---|
| 메서드(Method) | 액시스소프트 API 호출 시 사용해야 할 HTTP 요청 메서드입니다.(예: GET, POST, PUT, DELETE) |
| 호스트(Host) | 요청을 받는 액시스소프트 API 서버의 도메인입니다.(예: asia-northeast3-ovp-api-7737c.cloudfunctions.net/api) |
| URL | API를 통해 제공되는 리소스마다 지정된 요청 경로입니다.호스트와 함께 각 API의 엔드포인트(Endpoint)를 구성합니다. |
| 헤더(Header) | API 호출 시 필요한 인증 정보를 전달하는 데 사용합니다. (예: api_key: [고객사key]) |
| 파라미터(Parameter) | 요청 처리에 필요한 데이터를 전달하는 데 사용합니다.파라미터는 키와 값의 쌍으로 구성되며, 쿼리 스트링(Query string) 또는 본문을 통해 전달합니다.각 파라미터는 자료형(Data type)과 필수 전달 여부가 지정돼 있습니다. |
API 요청에 대해 JSON형식의 응답 코드와 응답 필드로 구성된 응답을 제공합니다.
| 메서드 | URL | 인증 방식 |
|---|---|---|
| GET | https://asia-northeast3-ovp-api-7737c.cloudfunctions.net/api/transcoding/list | 고객사 전용 KEY 인증 |
| 이름 | 설명 | 필수 |
|---|---|---|
| api_key | api_key: [고객사KEY] | O |
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| curp | number | 현재 페이지(예:1) |
O |
| perp | number | 페이지당 리스트(예:10) |
O |
| uid | string | 등록자 검색 | X |
| fname | string | 컨텐츠명 검색 | X |
| regyear | number | 등록년도 검색 (예: YYYY) |
X |
| sdate | date | 월단위 검색 (예: YYYY-MM-DD) |
X |
| edate | date | 월단위 검색 (예: YYYY-MM-DD) |
X |
| 이름 | 타입 | 설명 |
|---|---|---|
| status | boolean | 상태 값(예: true, false) |
| message | string | 상태 메세지 |
| rows | number | 전체 데이터 수 (예: 20) |
| rows | number | 전체 데이터 수 (예: 20) |
| data | data[] | 상세 데이터 |