Skip to content

tinder API

Jump to bottom
jungpyolee edited this page Sep 2, 2021 · 6 revisions

아래 API는 이정표가 작성했으며 궁금하신 부분있으면 언제든 연락주세요!

createTinder

getHistory

createReport

updateLike

getTopTinder

getHOF

getTotalTinder

getTotalLike

아래 getTinder API는 장효택이 작성했으며 궁금하신 부분있으면 언제든 연락주세요!

  1. [ 21.8.23 | getTinder field 추가 ] : gameId 필드 추가.

getTinder

틴더 CRUD에 이용되는 API입니다.

Base URL

http://3.37.194.249/tinder

createTinder

description

틴더 생성

Req

  • method

    POST

  • url

    /create

  • header

    Method parameter Description Required
    accesstoken {{token}} accesstoken(1hr) O
    refreshtoken {{token}} refreshtoken(30days) O

  • body

    Field Type Description Required
    msg String 틴더 메세지 O
    gameId Int 해당 게임 id (게임중일때 넣어주세요)

Res

  • success
{
  "success": true,
  "status": 200,
  "data": "틴더 생성 성공"
}

-fail

{
  "success": false,
  "status": 400,
  "msg": "틴더 생성 실패"
}

getHistory

description

틴더 히스토리 조회

Req

  • method

    GET

  • url

    /history

  • header

    Method parameter Description Required
    accesstoken {{token}} accesstoken(1hr) O
    refreshtoken {{token}} refreshtoken(30days) O

Res

  • success
{
  "success": true,
  "status": 200,
  "data": [
        {
            "id": {int},
            "message": {{string}},
            "like": {{int}},
            "superlike": {{int}},
            "dislike": {{int}},
            "pass": {{int}},
            "createdAt": {{datetime}},
            "updatedAt": {{datetime}},
            "userId": {{int}},
            "gameId": {{int}},
            "teamId": {{int}}
        },   {
            "id": {{int}},
            "message": {{string}},
            "like": {{int}},
            "superlike": {{int}},
            "dislike": {{int}},
            "pass": {{int}},
            "createdAt": {{datetime}},
            "updatedAt": {{datetime}},
            "userId": {{int}},
            "gameId": {{int}},
            "teamId": {{int}}
        }]}

-fail

하루동안 작성된 틴더가 없을때

{
  "success": false,
  "status": 401,
  "msg": "하루동안 히스토리가 없습니다."
}

그냥 실패했을 때

{
  "success": false,
  "status": 400,
  "msg": "히스토리 조회 실패"
}

getTinder

description

최근 1분 내의 틴더 받기.

Req

  • method

    GET

  • url

    /

  • example url

    /tinder?count=3&filter=1,3

  • header

    Method parameter Description Required
    accesstoken {{token}} accesstoken(1hr) O
    refreshtoken {{token}} refreshtoken(30days) O
    • params
    key type Description
    count number 받고싶은 틴더의 개수
    filter string 받고싶지 않은 팀들의 id 문자열 조합. ','로 연결된 String. ex) "1,2,5"

Res

  • success
{
  "success": true,
  "status": 200,
  "data": [
    {
      "id": 55,
      "gameId": null,
      "message": "베이스 url 테스트입니다22",
      "like": 0,
      "superlike": 0,
      "dislike": 0,
      "pass": 0,
      "createdAt": "2021-08-23T13:24:03.000Z",
      "user": {
        "id": 49,
        "nickname": "hahahsa"
      },
      "team": {
        "id": 1,
        "icon": "https://cdn.pandascore.co/images/team/image/128409/dwg_ki_alogo_square.png",
        "name": "DK"
      }
    },
    {
      "id": 54,
      "gameId": null,
      "message": "베이스 url 테스트입니다",
      "like": 0,
      "superlike": 0,
      "dislike": 0,
      "pass": 0,
      "createdAt": "2021-08-23T13:24:00.000Z",
      "user": {
        "id": 49,
        "nickname": "hahahsa"
      },
      "team": {
        "id": 1,
        "icon": "https://cdn.pandascore.co/images/team/image/128409/dwg_ki_alogo_square.png",
        "name": "DK"
      }
    }
  ]
}
  • Field Type Description
    success boolean 응답 성공 여부
    status number Status Code
    data list 각 틴더
    data.id number 틴더 id
    data.gameId number 해당 경기 id, 경기 진행 중이 아니면 null
    data.message string 틴더 메시지
    data.like number 틴더 like 수
    data.superlike number 틴더 superlike 수
    data.dislike number 틴더 dislike 수
    data.pass number 틴더 pass 수
    data.createdAt date tinder 생성일
    data.user.id number 틴더 작성자의 id
    data.user.nickname number 틴더 작성자의 닉네임
    data.team.id number 틴더 작성자의 팀 id
    data.team.icon number 틴더 작성자의 팀 icon
    data.team.name number 틴더 작성자의 팀 name

  • fail

    {
  "success": false,
  "status": 500,
  "msg": "internal Error"
}

createReport

description

틴더 리폿 생성

Req

  • method

    POST

  • url

    /report

  • header

    Method parameter Description Required
    accesstoken {{token}} accesstoken(1hr) O
    refreshtoken {{token}} refreshtoken(30days) O

  • body

    Field Type Description Required
    tinderId Int 리폿 대상 틴더의 id O
    reportMsg text 리폿 내용 O

Res

  • success
{
  "success": true,
  "status": 200,
  "data": "리폿 성공"
}

리폿 성공시에 리폿된 틴더에 대한 처리나 유저에 대한 제재에 대한 로직은 아직 구현되지 않았습니다.

-fail

{
  "success": false,
  "status": 400,
  "msg": "리폿 실패"
}

틴더id나 리폿메시지가 body에 담겨있지 않을경우

{
  "success": false,
  "status": 400,
  "msg": "틴더id나 리폿메시지가 부족합니다."
}

updateLike

description

틴더 리액션 추가(업데이트)

Req

  • method

    PUT

  • url

    /react

  • header

    Method parameter Description Required
    accesstoken {{token}} accesstoken(1hr) O
    refreshtoken {{token}} refreshtoken(30days) O

  • body

    Field Type Description Required
    tinderId Int 리액션 대상 틴더의 id O
    like Int like 선택 시 1, 아니면 0 O
    dislike Int dislike 선택 시 1, 아니면 0 O
    superlike Int superlike 선택 시 1, 아니면 0 O
    pass Int pass 선택 시 1, 아니면 0 O

Res

  • success
{
  "success": true,
  "status": 200,
  "data": "리액션 성공"
}

-fail

{
  "success": false,
  "status": 400,
  "msg": "리액션 실패"
}

틴더id나 리폿메시지가 body에 담겨있지 않을경우

{
  "success": false,
  "status": 400,
  "msg": "틴더id나 리액션정보가 부족합니다."
}

getTopTinder

description

경기 결과 페이지에서 MOG 최대 10개 받기

Req

  • method

    GET

  • url

    /toptinder

  • example url

    /tinder/toptinder?gameId=271

  • header

    Method parameter Description Required
    accesstoken {{token}} accesstoken(1hr) O
    refreshtoken {{token}} refreshtoken(30days) O
    • params
    key type Description
    gameId int 해당 게임id

Res

  • success
{
  "success": true,
  "status": 200,
  "data": [
    {
      "id": 26,
      "rank": 1,
      "tinderId": 40,
      "tinder": {
        "id": 40,
        "message": "나중에만듬",
        "gameId": 271,
        "like": 5,
        "superlike": 5,
        "dislike": 5,
        "pass": 0,
        "createdAt": "2021-08-20T04:28:57.000Z",
        "user": {
          "id": 49,
          "nickname": "hahahsa"
        },
        "team": {
          "id": 2,
          "icon": "https://cdn.pandascore.co/images/team/image/128218/fredit_brio_nlogo_square.png",
          "name": "BRO"
        }
      }
    },
    {
      "id": 25,
      "rank": 2,
      "tinderId": 39,
      "tinder": {
        "id": 39,
        "message": "나중에만듬",
        "gameId": 271,
        "like": 4,
        "superlike": 4,
        "dislike": 4,
        "pass": 0,
        "createdAt": "2021-08-20T04:28:57.000Z",
        "user": {
          "id": 49,
          "nickname": "hahahsa"
        },
        "team": {
          "id": 3,
          "icon": "https://cdn.pandascore.co/images/team/image/128217/nongshim_red_forcelogo_square.png",
          "name": "NS"
        }
      }
    }
  ]
}
  • Field Type Description
    success boolean 응답 성공 여부
    status number Status Code
    data list 각 MOG를 담고있는 배열
    data.id number MOG id
    data.rank number MOG 순위
    data.tinderId number 해당 MOG의 tinderId
    data.tinder object tinder 정보를 담고있는 객체
    data.tinder.id number tinder id
    data.tinder.gameId number 해당 경기 id
    data.tinder.message string 틴더 메시지
    data.tinder.like number 틴더 like 수
    data.tinder.superlike number 틴더 superlike 수
    data.tinder.dislike number 틴더 dislike 수
    data.tinder.pass number 틴더 pass 수
    data.tinder.createdAt date tinder 생성일
    data.tinder.user.id number 틴더 작성자의 id
    data.tinder.user.nickname number 틴더 작성자의 닉네임
    data.tinder.team.id number 틴더 작성자의 팀 id
    data.tinder.team.icon number 틴더 작성자의 팀 icon
    data.tinder.team.name number 틴더 작성자의 팀 name

  • fail

    {
  "success": false,
  "status": 500,
  "msg": "internal Error"
}

getHOF

description

History 페이지에서 명예의 전당 정보 받기

Req

  • method

    GET

  • url

    /hof

  • header

    Method parameter Description Required
    accesstoken {{token}} accesstoken(1hr) O
    refreshtoken {{token}} refreshtoken(30days) O

Res

  • success

랭크 높은순, 최근순 정렬

{
  "success": true,
  "status": 200,
  "data": [
    {
      "id": 26,
      "rank": 1,
      "tinderId": 40,
      "tinder": {
        "id": 40,
        "message": "나중에만듬",
        "gameId": 271,
        "like": 5,
        "superlike": 5,
        "dislike": 5,
        "pass": 0,
        "createdAt": "2021-08-20T04:28:57.000Z",
        "user": {
          "id": 49,
          "nickname": "hahahsa"
        }
      }
    },
    {
      "id": 15,
      "rank": 1,
      "tinderId": 32,
      "tinder": {
        "id": 32,
        "message": "나중에만듬1",
        "gameId": 360,
        "like": 1,
        "superlike": 3,
        "dislike": 0,
        "pass": 0,
        "createdAt": "2021-08-19T08:40:45.000Z",
        "user": {
          "id": 49,
          "nickname": "hahahsa"
        }
      }
    }
  ]
}
  • Field Type Description
    success boolean 응답 성공 여부
    status number Status Code
    data list 각 MOG를 담고있는 배열
    data.id number MOG id
    data.rank number MOG 순위
    data.tinderId number 해당 MOG의 tinderId
    data.tinder object tinder 정보를 담고있는 객체
    data.tinder.id number tinder id
    data.tinder.gameId number 해당 경기 id
    data.tinder.message string 틴더 메시지
    data.tinder.like number 틴더 like 수
    data.tinder.superlike number 틴더 superlike 수
    data.tinder.dislike number 틴더 dislike 수
    data.tinder.pass number 틴더 pass 수
    data.tinder.createdAt date tinder 생성일
    data.tinder.user.id number 틴더 작성자의 id
    data.tinder.user.nickname number 틴더 작성자의 닉네임

  • fail

    {
  "success": false,
  "status": 500,
  "msg": "internal Error"
}

getTotalTinder

description

유저가 작성한 틴더 개수 가져오기

Req

  • method

    GET

  • url

    /totalTinder

  • header

    Method parameter Description Required
    accesstoken {{token}} accesstoken(1hr) O
    refreshtoken {{token}} refreshtoken(30days) O

Res

  • success
{
  "success": true,
  "status": 200,
  "data": int
}
  • Field Type Description
    success boolean 응답 성공 여부
    status number Status Code
    data int 유저가 작성한 전체틴더 개수

  • fail

    {
  "success": false,
  "status": 500,
  "msg": "internal Error"
}

getTotalLike

description

유저가 받은 총 like + superlike 가져오기

Req

  • method

    GET

  • url

    /totalLike

  • header

    Method parameter Description Required
    accesstoken {{token}} accesstoken(1hr) O
    refreshtoken {{token}} refreshtoken(30days) O

Res

  • success
{
  "success": true,
  "status": 200,
  "data": int
}
  • Field Type Description
    success boolean 응답 성공 여부
    status number Status Code
    data int 유저가 받은 총 like + superlike 개수

  • fail

    {
  "success": false,
  "status": 500,
  "msg": "internal Error"
}
Clone this wiki locally