PhiZone API v2
  1. Player
PhiZone API v2
  • Authentication
    • Revokes a refresh token.
      POST
    • Retrieves authentication credentials.
      POST
    • Requests identity from an authentication provider.
      POST
    • Sends an email to user's email address.
      POST
    • Resets user's password.
      POST
    • Retrieves TapTap user info.
      POST
    • Revokes user's account.
      POST
  • User
    • Retrieves users.
      GET
    • Creates a new user.
      POST
    • Retrieves a specific user.
      GET
    • Updates a user.
      PATCH
    • Creates a new user.
      POST
    • Creates a new user using a specified auth provider.
      POST
    • Binds a user to a TapTap account.
      POST
    • Updates a user's avatar.
      PATCH
    • Unbinds a user from a TapTap account.
      DELETE
    • Removes a user's avatar.
      DELETE
    • Retrieves followers of user.
      GET
    • Retrieves followees of user.
      GET
    • Follows a user.
      POST
    • Retrieves a user's best play records.
      GET
    • Unfollows a user.
      POST
    • Retrieves a user's personal bests.
      GET
  • Region
    • Retrieves regions.
    • Retrieves a specific region.
    • Retrieves a specific region by its ID.
    • Retrieves users from a specified region.
    • Retrieves users from a specified region by its ID.
  • UserInfo
    • Retrieves user's information.
    • Generates and retrieves a login token.
    • Binds a user to an account on a specified authentication provider.
    • Unbinds a user from an account on a specified authentication provider.
    • Binds a user to a TapTap account.
    • Unbinds a user from a TapTap account.
    • Requests to migrate data on a TapTap ghost account to a formal user account.
    • Migrates data on a TapTap ghost account to a formal user account.
  • UserRelation
    • Retrieves user relations.
    • Retrieves a specific user relation.
  • Chapter
    • Retrieves chapters.
    • Creates a new chapter.
    • Retrieves a specific chapter.
    • Updates a chapter.
    • Removes a chapter.
    • Updates a chapter's illustration.
    • Retrieves songs from a specified chapter.
    • Retrieves likes from a specified chapter.
    • Likes a specific chapter.
    • Removes the like from a specified chapter.
    • Retrieves comments from a specified chapter.
    • Comments on a specific chapter.
  • Chart
    • Retrieves charts.
    • Creates a new chart.
    • Retrieves a specific chart.
    • Updates a chart.
    • Removes a chart.
    • Retrieves a specific chart using a TapTap ghost account.
    • Retrieves a random chart.
    • Updates a chart's file.
    • Removes a chart's file.
    • Updates a chart's illustration.
    • Removes a chart's illustration.
    • Retrieves chart's assets.
    • Creates a new chart's asset.
    • Creates a chart's asset.
    • Retrieves a specific chart's asset.
    • Updates a chart's asset.
    • Removes a chart's asset.
    • Updates the file for a chart's asset.
    • Creates a new authorship for a chart.
    • Retrieves admissions received by collections.
    • Makes a request to have a chart admitted by a collection.
    • Retrieves an admission received by a collection.
    • Removes a chart from a collection that has admitted the chart.
    • Retrieves the leaderboard of a specified chart.
    • Retrieves records from a specific chart.
    • Retrieves likes from a specified chart.
    • Likes a specific chart.
    • Removes the like from a specified chart.
    • Retrieves comments from a specified chart.
    • Comments on a specific chart.
    • Retrieves votes from a specified chart.
    • Votes a specific chart.
    • Removes the vote from a specified chart.
    • Links a chart to a specific event division.
  • Song
    • Retrieves songs.
    • Creates a new song.
    • Retrieves a specific song.
    • Updates a song.
    • Removes a song.
    • Retrieves a random song.
    • Updates a song's file.
    • Updates a song's illustration.
    • Updates a song's license.
    • Removes a song's license.
    • Creates a new authorship for a song.
    • Retrieves admissions received by chapters.
    • Makes a request to have a song admitted by a chapter.
    • Retrieves an admission received by a chapter.
    • Removes a song from a chapter that has admitted the song.
    • Retrieves charts from a specified song.
    • Retrieves likes from a specified song.
    • Likes a specific song.
    • Removes the like from a specified song.
    • Retrieves comments from a specified song.
    • Comments on a specific song.
    • Links a song to a specific event division.
  • Application
    • Retrieves applications.
    • Creates a new application.
    • Retrieves a specific application.
    • Updates an application.
    • Removes an application.
    • Updates an application's avatar.
    • Updates an application's illustration.
    • Retrieves likes from a specified application.
    • Likes a specific application.
    • Removes the like from a specified application.
    • Retrieves comments from a specified application.
    • Comments on a specific application.
    • Creates a new service script.
    • Updates a service script.
  • Comment
    • Retrieves comments.
    • Retrieves a specific comment.
    • Removes a comment.
    • Retrieves replies from a specified comment.
    • Replies to a specific comment.
    • Retrieves likes from a specified comment.
    • Likes a specific comment.
    • Removes the like from a specified comment.
  • Record
    • Retrieves records.
    • Creates a new record.
    • Retrieves a specific record.
    • Removes a record.
    • Creates a new record using a TapTap ghost account.
    • Retrieves likes from a specified record.
    • Likes a specific record.
    • Removes the like from a specified record.
    • Retrieves comments from a specified record.
    • Comments on a specific record.
    • Links a record to a specific event division.
  • Reply
    • Retrieves replies.
    • Retrieves a specific reply.
    • Removes a reply.
    • Retrieves likes from a specified reply.
    • Likes a specific reply.
    • Removes the like from a specified reply.
  • Player
    • Retrieves configurations.
      GET
    • Creates a new configuration.
      POST
    • Retrieves a specific configuration.
      GET
    • Updates a configuration.
      PATCH
    • Removes a configuration.
      DELETE
    • Obtains a play token.
      GET
    • Obtains a play token using a TapTap ghost account.
      GET
  • Announcement
    • Retrieves announcements.
    • Creates a new announcement.
    • Retrieves a specific announcement.
    • Updates an announcement.
    • Removes an announcement.
    • Retrieves likes from a specified announcement.
    • Likes a specific announcement.
    • Removes the like from a specified announcement.
    • Retrieves comments from a specified announcement.
    • Comments on a specific announcement.
  • Admission
    • Retrieves admissions received by chapters.
    • Retrieves chart admissions.
    • Retrieves admissions received by collections.
    • Retrieves admissions received by songs.
    • Retrieves an admission requested from a song.
    • Removes a song admission.
    • Retrieves admissions received by song submissions.
    • Retrieves an admission requested from a chart.
    • Retrieves an admission received by a chapter.
    • Removes a chart admission.
    • Removes an admission received by a chapter.
    • Retrieves an admission received by a collection.
    • Reviews a song admission.
    • Removes an admission received by a collection.
    • Reviews a chart admission.
    • Retrieves an admission received by a song.
    • Retrieves an admission received by a song submission.
    • Reviews an admission received by a chapter.
    • Reviews an admission received by a collection.
    • Reviews an admission received by a song.
    • Reviews an admission received by a song submission.
  • Authorship
    • Retrieves authorships.
    • Retrieves a specific authorship.
    • Updates an authorship.
    • Removes an authorship.
  • Collaboration
    • Retrieves collaborations.
    • Retrieves a specific collaboration.
    • Updates a collaboration.
    • Removes a collaboration.
    • Reviews a collaboration.
  • Notification
    • Retrieves notifications.
    • Marks notifications as read.
    • Retrieves a specific notification.
    • Removes a notification.
    • Marks a specific notification as read.
  • ChartSubmission
    • Retrieves chart submissions.
    • Creates a new chart submission.
    • Retrieves a specific chart submission.
    • Updates a chart submission.
    • Removes a chart submission.
    • Updates a chart submission's file.
    • Updates a chart submission's illustration.
    • Removes a chart submission's illustration.
    • Retrieves chart submission's assets.
    • Creates a new chart submission's asset.
    • Retrieves a specific chart submission's asset.
    • Updates a chart submission's asset.
    • Removes a chart submission's asset.
    • Creates new chart submission's assets.
    • Updates the file for a chart submission's asset.
    • Applies a specific chart submission to an application service.
    • Applies a specific chart submission to a service script.
    • Retrieves service records.
    • Creates a new collaboration for a chart.
    • Retrieves a specific service record.
    • Retrieves votes from a specified chart submission.
    • Votes a specific chart submission.
    • Removes the vote from a specified chart submission.
    • Checks for any event participation with provided tags.
  • SongSubmission
    • Retrieves song submissions.
    • Creates a new song submission.
    • Retrieves a specific song submission.
    • Updates a song submission.
    • Removes a song submission.
    • Updates a song submission's file.
    • Updates a song submission's illustration.
    • Updates a song submission's license.
    • Removes a song submission's license.
    • Updates a song submission's originality proof.
    • Removes a song submission's originality proof.
    • Applies a specific song submission to a service script.
    • Applies a specific song submission to an application service.
    • Creates a new collaboration for a song.
    • Retrieves service records.
    • Reviews a song submission.
    • Retrieves a specific service record.
    • Checks for any event participation with provided tags.
  • Pet
    • Retrieves objective questions.
    • Answers objective questions and retrieves subjective questions.
    • Answers subjective questions.
    • Retrieves answers.
    • Reviews an answer.
    • Retrieves a specific answer.
    • Reviews an answer.
  • ResourceRecord
    • Retrieves resource records.
    • Creates a new resource record.
    • Retrieves a specific resource record.
    • Updates a resource record.
    • Removes a resource record.
    • Creates new resource records.
  • Collection
    • Retrieves collections.
    • Creates a new collection.
    • Retrieves a specific collection.
    • Updates a collection.
    • Removes a collection.
    • Updates a collection's illustration.
    • Retrieves charts from a specified collection.
    • Retrieves likes from a specified collection.
    • Likes a specific collection.
    • Removes the like from a specified collection.
    • Retrieves comments from a specified collection.
    • Comments on a specific collection.
  • Tag
    • Retrieves tags.
    • Creates a new tag.
    • Retrieves a specific tag.
    • Updates a tag.
    • Removes a tag.
    • Retrieves a specific tag by its name.
    • Retrieves songs from a specified tag.
    • Retrieves charts from a specified tag.
    • Links a tag to a specific event division.
  • Event
    • Retrieves events.
    • Creates a new event.
    • Retrieves a specific event.
    • Updates an event.
    • Removes an event.
    • Retrieves divisions of a specified event.
    • Updates an event's illustration.
    • Retrieves likes from a specified event.
    • Likes a specific event.
    • Removes the like from a specified event.
    • Retrieves comments from a specified event.
    • Comments on a specific event.
    • Creates a new service script.
    • Creates an invite code for a specific event.
    • Updates a service script.
  • EventDivision
    • Retrieves event divisions.
    • Creates a new event division.
    • Retrieves a specific event division.
    • Updates an event division.
    • Removes an event division.
    • Retrieves song prompts of a specified event division.
    • Retrieves chart prompts of a specified event division.
    • Retrieves tags of a specified event division.
    • Retrieves song entries of a specified event division. Note that the search string and authorship-related filters are disabled for divisions that require anonymization.
    • Retrieves chart entries of a specified event division. Note that the search string and authorship-related filters are disabled for divisions that require anonymization.
    • Retrieves record entries of a specified event division. Note that the search string and authorship-related filters are disabled for divisions that require anonymization.
    • Retrieves the leaderboard of a specified event division.
    • Retrieves tasks of a specified event division.
    • Retrieves reserved fields of a specified event division.
    • Updates an event division's illustration.
    • Removes an event division's illustration.
    • Retrieves likes from a specified event division.
    • Likes a specific event division.
    • Removes the like from a specified event division.
    • Retrieves comments from a specified event division.
    • Comments on a specific event division.
    • Creates a new service script.
    • Updates a service script.
  • EventTask
    • Retrieves event tasks.
    • Creates a new event task.
    • Retrieves a specific event task.
    • Updates an event task.
    • Removes an event task.
    • Retrieves tasks of a specific event task.
  • EventResource
    • Retrieves event resources.
    • Retrieves a specific event resource.
    • Updates an event resource.
    • Removes an event resource.
    • Retrieves reserved fields of event resources.
    • Retrieves reserved fields of a specified event resource.
    • Updates a specific reserved field of a specified event resource.
  • EventTeam
    • Retrieves event teams.
    • Creates a new event team.
    • Retrieves a specific event team.
    • Updates an event team.
    • Removes an event team.
    • Retrieves reserved fields of event teams.
    • Retrieves reserved fields of a specified event team.
    • Updates a specific reserved field of the specified event team.
    • Updates an event team's icon.
    • Removes an event team's icon.
    • Retrieves likes from a specified event team.
    • Likes a specific event team.
    • Removes the like from a specified event team.
    • Creates an invite code for a specific event team.
    • Retrieves details of the specified invitation.
    • Accepts an invitation.
    • Updates a participation.
    • Removes a participation.
  • ServiceScript
    • Retrieves service scripts.
    • Creates a new service script.
    • Retrieves a specific service script.
    • Updates a service script.
    • Removes a service script.
    • Uses a specific service script.
    • Retrieves service records.
    • Retrieves a specific service record.
  • Hostship
    • Retrieves hostships.
    • Creates a new hostship.
    • Retrieves a specific hostship.
    • Updates a hostship.
    • Removes a hostship.
    • Retrieves details of a specified invitation.
    • Accepts an invitation.
  • Submission
    • Creates a submission session.
    • Uploads song and illustration for the user's submission session.
    • Creates a new song submission for the user's submission session.
    • Uploads file and metadata for a new chart submission for the user's submission session.
    • Creates a new chart submission's asset for the user's submission session.
    • Creates new chart submission's assets for the user's submission session.
    • Creates the chart submission for the user's submission session.
  • Retrieves an abstract of site info.
    GET
  • Retrieves headline.
    GET
  • Retrieves studio's headline.
    GET
  1. Player

Obtains a play token.

GET
/player/play
Player

请求参数

Authorization
在 Header 添加参数
Authorization
，其值为在 Bearer 之后拼接 Token
示例：
Authorization: Bearer ********************
Query 参数
chartId
string 
可选
configurationId
string 
可选
applicationId
string 
可选
teamId
string 
可选

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.phizone.cn/player/play'

返回响应

🟢200Returns a play token and a timestamp of the current time in UTC, along with necessary resources required for the play.
application/json
Body
status
enum<integer> <int32>
可选
枚举值:
0123456
code
string  | null 
可选
message
string  | null 
可选
errors
array[object (ModelErrorDto) {2}]  | null 
可选
field
string  | null 
可选
errors
array[string] | null 
可选
dateAvailable
string <date-time> | null 
可选
total
integer <int32> | null 
可选
perPage
integer <int32> | null 
可选
hasPrevious
boolean  | null 
可选
hasNext
boolean  | null 
可选
data
object (PlayResponseDto) 
可选
token
string <uuid>
可选
timestamp
integer <int64>
可选
chart
object (ChartDto) 
可选
示例
{
  "status": 0,
  "code": "string",
  "message": "string",
  "errors": [
    {
      "field": "string",
      "errors": [
        "string"
      ]
    }
  ],
  "dateAvailable": "2019-08-24T14:15:22Z",
  "total": 0,
  "perPage": 0,
  "hasPrevious": true,
  "hasNext": true,
  "data": {
    "token": "b5507016-7da2-4777-a161-1e8042a6a377",
    "timestamp": 0,
    "chart": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "title": "string",
      "levelType": 0,
      "level": "string",
      "difficulty": 0,
      "format": 0,
      "file": "string",
      "fileChecksum": "string",
      "authorName": "string",
      "illustration": "string",
      "illustrator": "string",
      "description": "string",
      "accessibility": 0,
      "isHidden": true,
      "isLocked": true,
      "isRanked": true,
      "noteCount": 0,
      "score": 0,
      "rating": 0,
      "ratingOnArrangement": 0,
      "ratingOnGameplay": 0,
      "ratingOnVisualEffects": 0,
      "ratingOnCreativity": 0,
      "ratingOnConcord": 0,
      "ratingOnImpression": 0,
      "tags": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string",
          "normalizedName": "string",
          "description": "string",
          "dateCreated": "2019-08-24T14:15:22Z"
        }
      ],
      "assets": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "ownerId": 0,
          "chartId": "54f93a91-b046-4439-9ec5-17949db5a60d",
          "type": 0,
          "name": "string",
          "file": "string",
          "dateCreated": "2019-08-24T14:15:22Z",
          "dateUpdated": "2019-08-24T14:15:22Z"
        }
      ],
      "songId": "1cc07533-4e7c-4ac6-ac63-9093ee3bd8ac",
      "song": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "title": "string",
        "editionType": 0,
        "edition": "string",
        "authorName": "string",
        "file": "string",
        "fileChecksum": "string",
        "illustration": "string",
        "illustrator": "string",
        "description": "string",
        "accessibility": 0,
        "isHidden": true,
        "isLocked": true,
        "lyrics": "string",
        "bpm": 0,
        "minBpm": 0,
        "maxBpm": 0,
        "offset": 0,
        "license": "string",
        "isOriginal": true,
        "duration": "string",
        "previewStart": "string",
        "previewEnd": "string",
        "chartLevels": [
          {
            "levelType": 0,
            "count": 0
          }
        ],
        "tags": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "name": "string",
            "normalizedName": "string",
            "description": "string",
            "dateCreated": "2019-08-24T14:15:22Z"
          }
        ],
        "playCount": 0,
        "likeCount": 0,
        "ownerId": 0,
        "dateCreated": "2019-08-24T14:15:22Z",
        "dateFileUpdated": "2019-08-24T14:15:22Z",
        "dateUpdated": "2019-08-24T14:15:22Z",
        "dateLiked": "2019-08-24T14:15:22Z"
      },
      "playCount": 0,
      "likeCount": 0,
      "ownerId": 0,
      "dateCreated": "2019-08-24T14:15:22Z",
      "dateFileUpdated": "2019-08-24T14:15:22Z",
      "dateUpdated": "2019-08-24T14:15:22Z",
      "dateLiked": "2019-08-24T14:15:22Z"
    }
  }
}
🟠400When any of the parameters is invalid.
🟠401When the user is not authorized.
🟠403When the user does not have sufficient permission.
🟠404When either the chart, the configuration, or the application is not found.
上一页
Removes a configuration.
下一页
Obtains a play token using a TapTap ghost account.
Built with