초대하기 API - mash-up-kr/luvket-backend GitHub Wiki

상대방 초대 토큰 발급

• Endpoint: POST /api/invites

• Header

key	value
uid	837DFH97DFJKE8

• Response
  • status code: 200

{
  "code": 200,
  "msg": "초대 토큰 발급 성공",
  "data": {
    "token": "0FE57B2CA5"
  }
}

초대토큰으로 상대방 정보 조회 API

• Endpoint: GET /api/invites/{token}

• Response

  • status code: 200

{
    "code": 200,
    "message": "초대한 사용자 정보",
    "data": {
        "name": "이름",
        "profileImageUrl": ""
    }
}

• Exception
  • 초대 토큰이 만료되었을 경우
    • Http status code: 200
    • Response body

    {
      "errorCode": 4401,
      "errorMsg": "시간이 만료된 초대 토큰입니다."
    }
    

  • 올바르지 않은 초대토큰 일 경우
    • Http status code: 400
    • Response body

    {
      "errorCode": 4402,
      "errorMsg": "올바르지 않은 초대 토큰 입니다."
    }
    

초대 수락 API

• Endpoint: POST /api/invites/{token}/accept

• Header

key	value
uid	837DFH97DFJKE8

• Response
  • status code: 201

{
    "code": 201,
    "message": "초대 수락 성공",
}

• Exception
  • 초대 수락 할 수 없는 상태
    • Http status code: 400
    • Response body

    {
      "errorCode": 4403,
      "errorMsg": "올바르지 않는 초대입니다."
    }