PhiZone API v2
  1. Authentication
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.
      GET
    • Retrieves a specific region.
      GET
    • Retrieves a specific region by its ID.
      GET
    • Retrieves users from a specified region.
      GET
    • Retrieves users from a specified region by its ID.
      GET
  • 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.
    • Creates a new configuration.
    • Retrieves a specific configuration.
    • Updates a configuration.
    • Removes a configuration.
    • Obtains a play token.
    • Obtains a play token using a TapTap ghost account.
  • 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. Authentication

Sends an email to user's email address.

POST
/auth/sendEmail

请求参数

Query 参数

Body 参数application/json

示例
{
    "email": "user@example.com",
    "userName": "string",
    "language": "string",
    "mode": 0
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.phizone.cn/auth/sendEmail' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "user@example.com",
    "userName": "string",
    "language": "string",
    "mode": 0
}'

返回响应

🟢204Returns an empty body. Sends an email to the email address.
application/json
Body

示例
{}
🟠400When 1. the user's email address is in cooldown; 2. the mode is email confirmation and the user has already been activated.
🟠403When the user does not have sufficient permission.
🟠404When the user has input an email address that does not match any existing user.
🔴500When a Redis / Mail Service error has occurred.
修改于 2025-05-17 18:17:13
上一页
Requests identity from an authentication provider.
下一页
Resets user's password.
Built with