run‐together API

응답

• 요청 성공 시: HTTP 상태 코드와 API 별 성공 응답 필드를 반환
• 요청 실패 시: HTTP 상태 코드와 JSON형식의 에러 응답 필드를 반환

에러 응답 필드

이름	타입	설명
code	Int	에러 코드
msg	String	에러 메시지로 에러 원인에 대한 참고 정보

동네 인증

인증 받고자 하는 동네 범위 안에 현재 사용자가 있는지 확인합니다.

메서드: POST

콘텐츠 유형: application/json

엔드포인트

http://run-together.com/neighborhood/verification

요청 본문 페이로드

속성 이름	유형	설명
latitude	number	사용자의 현재 위치 위도
longitude	number	사용자의 현재 위치 경도
neighborhoodId	number	인증을 원하는 동네 ID

요청 예시

curl 'http://run-together.com/neighborhood/{neighborhodID}/verification' \
-H 'Content-Type: application/json' \
--data'{"latitude": 37.5665, "longitude": 126.9780, "neighborhoodId": 3294}'

응답 페이로드

속성 이름	유형	설명
verifyId	string	동네 인증 traceID
verified	boolean	동네 범위 내에 있는지 여부
verificationTime	string	인증을 수행한 시간

응답 예시

{   
  "verifyId": "tRcfmLH7o2...",
  "verified": true,
  "verificationTime": "2024-10-16T10:01:00Z"
}

• data: 요청한 정보들을 담아 제공
• meta: 요청한 정보 외 추가 정보(요청 ID, 타임스탬프 등)를 제공

오류 코드

에러 코드	에러 메시지	HTTP 상태 코드
-301	해당 동네를 찾을 수 없습니다.	404
-355	해당 동네 범위를 벗어났습니다.	400

오류 예시

{
  "code": "-355",
  "msg": "해당 동네 범위를 벗어났습니다."
}

동네 등록

사용자가 특정 동네를 자신의 동네로 등록합니다. 최대 2개의 동네만 등록할 수 있습니다.

메서드: POST

콘텐츠 유형: application/json

엔드포인트

http://run-together.com/users/neighborhoods

요청 본문 페이로드

속성 이름	유형	설명
neighborhoodId	number	등록을 원하는 동네 ID

요청 예시

curl 'http://run-together.com/myneighborhood/registration' \
-H 'Content-Type: application/json' \
--data'{"neighborhoodId": 3294}'

응답

HttpStatus: 200

오류 코드

에러 코드	에러 메시지	HTTP 상태 코드
-301	해당 동네를 찾을 수 없습니다.	404
-351	내 동네는 최대 2개만 등록할 수 있습니다.	400
-352	이미 내 동네로 등록된 동네입니다.	400
-353	내 동네로 등록되지 않은 동네입니다.	400
-354	이미 인증된 동네입니다.	400

오류 예시

{
  "code": "-351",
  "msg": "내 동네는 최대 2개만 등록할 수 있습니다."
}

내 동네 삭제

사용자가 등록한 내 동네를 삭제합니다.

메서드: DELETE

엔드포인트

http://run-together.com/users/neighborhoods/{neighborhoodId}

요청 예시

curl 'http://run-together.com/neighborhoods/nbh_32d6b5dd-370a-485a-8612-eee34590d7e6'

응답

HttpStatus: 200

오류 코드

에러 코드	에러 메시지	HTTP 상태 코드
-301	해당 동네를 찾을 수 없습니다.	404
-353	내 동네로 등록되지 않은 동네입니다.	400

오류 예시

{
  "code": "-353",
  "msg": "내 동네로 등록되지 않은 동네입니다."
}