요청 구성
요청은 세 가지 구성 요소로 이루어집니다:
- API 버전
- 리소스 경로
- 출력 유형
적절한 요청을 구성하려면 다음과 같이 URI 형식을 지정해야 합니다:
https://api.yourepo.com/{version}/{resource}.{output_type}
패키지를 구매한 회원 목록을 가져오기 위한 요청 예시입니다.
https://api.yourepo.com/1.0/package/buyers.json?package=com.yourepo.source.package
기본적으로 요청은 HTTP GET 요청입니다. 그러나 많은 방법을 사용하려면 POST 데이터를 보내야 합니다. 일반적으로 모든 읽기 요청은 GET을 사용하고 쓰기 요청은 POST를 사용하는 표준을 따릅니다.
각 개별 방법에 필요한 매개변수 외에 API 키도 보내야 합니다.
서버 측 API를 사용하는 경우 비밀 API 키 값과 함께 secret_key
를 보내야 합니다.
API 버전
각 요청에 대해 사용할 API 버전을 지정해야 합니다. 현재 기본값이며 사용 가능한 유일한 버전은 1.0입니다.
리소스 경로
리소스 경로는 추가 설명서에서 사용할 수 있습니다.
데이터 형식
YouRepo only supports one data format currently, JSON.
응답
요청 응답에는 다음과 같은 몇 가지 주요 사항이 포함됩니다:
- HTTP 상태 코드
- API 상태
코드
- API 응답 메시지
요청의 예를 들어보겠습니다:
GET https://api.yourepo.com/1.0/package/buyers?package=com.yourepo.source.package&secret_key=YOUR_SECRET_KEY{ "code": 0, "response": { "start": 0, "limit": 25, "total": "62", "page": 1, "buyers": [ { "nickname": "member1", "status": "Completed", "profile_url": "https:\/\/www.yourepo.com\/forum\/profile\/member1" }, { "nickname": "member2", "status": "Completed", "profile_url": "https:\/\/www.yourepo.com\/forum\/profile\/member2" }, ..... ] } }