run‐together API

동네 인증

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

메서드: 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-09-26T15:30:00Z"
}

오류 코드

HTTP 상태 코드	에러 코드	에러 메시지
400	INVALID_PARAMETERS	요청 파라미터가 올바르지 않습니다.
401	AUTHENTICATION_FAILED	인증되지 않은 사용자입니다.
404	USER_NOT_FOUND	사용자를 찾을 수 없습니다.
404	NEIGHBORHOOD_NOT_FOUND	동네를 찾을 수 없습니다.
422	VERIFICATION_FAILED	제공된 위치가 동네 경계 내에 있지 않습니다.
500	INTERNAL_SERVER_ERROR	서버 내부 오류가 발생했습니다.
503	SERVICE_UNAVAILABLE	서비스를 일시적으로 사용할 수 없습니다.

오류 예시

{
  "exception": {
    "code": 400,
    "reason": "INVALID_PARAMETERS",
    "message": "요청 파라미터가 올바르지 않습니다."
  }
}

{
  "exception": {
    "code": 422,
    "reason": "VERIFICATION_FAILED",
    "message": "제공된 위치가 동네 경계 내에 있지 않습니다."
    "metadata": {
      "verifyId": "tRcfmLH7o2...",
      "verified": false,
      "verificationTime": "2024-09-30T14:45:00Z"
    }
  }
}