Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Public API #17

Open
Brawl345 opened this issue Aug 9, 2022 · 5 comments
Open

Public API #17

Brawl345 opened this issue Aug 9, 2022 · 5 comments
Labels
enhancement New feature or request

Comments

@Brawl345
Copy link
Collaborator

Brawl345 commented Aug 9, 2022

There should be a public API where developers can read the tag info in a machine-readable format. This should be read-only for now, maybe with support for API keys so bots can't scrape just every user. I'm currently deciding on the data structure:

Example data structure
{
   "NOTE":"!!! This API is still in BETA and some fields may be removed in the future !!!",
   "user":{
      "id":"111",
      "name":"Brawl",
      "coins":30,
      "avatar_url":"https://cdn.discordapp.com/avatars/111...",
      "profile_url":"http://localhost:3000/user/110806999020625920",
      "member_since":"2021-11-29T20:46:56.782Z"
   },
   "mii":{
      "type":"upload",
      "data":"04c004....",
      "cmocEntryNo":null
   },
   "tag":{
      "url":{
         "normal":"http://localhost:3000/110806999020625920/tag.png",
         "max":"http://localhost:3000/110806999020625920/tag.max.png"
      },
      "settings":{
         "comment":"Some Comment",
         "flag":"de",
         "overlay":"overlay6",
         "background":"mac12.png",
         "coin":"mario",
         "font":"default",
         "coverType":"cover3D",
         "coverRegion":"EN",
         "showAvatar":true,
         "showMii":true
      }
   },
   "games":[
      {
         "game_id":"RMCE01",
         "console":"wii",
         "name":"Mario Kart Wii",
         "region":"US",
         "cover_url":"http://localhost:3000/api/cover/wii/RMCE01",
         "played_on":"2022-08-09T17:12:22.795Z"
      },
      {
         "game_id":"RSBJ01",
         "console":"wii",
         "name":"大乱闘スマッシュブラザーズX",
         "region":"JA",
         "cover_url":"http://localhost:3000/api/cover/wii/RSBJ01",
         "played_on":"2022-08-09T16:45:39.985Z"
      }
   ]
}

Undecided if I should also include the URLs to the assets (e.g. backgrounds, overlays, etc.) directly, but I think it's unnecessary.

@Brawl345 Brawl345 added the enhancement New feature or request label Aug 9, 2022
Brawl345 added a commit that referenced this issue Aug 9, 2022
@Volukot
Copy link

Volukot commented Jun 8, 2023

+1

matthe815 added a commit to matthe815/LinkTag-Next that referenced this issue Jan 28, 2024
* Feature: Moderation (RiiConnect24#9) (RiiConnect24#10)

* feature: Added banning, and, forced hidden button

* feature: Added hiding and shadow hiding users

* feature: Added badges to user profile

* feature: Added hiding from the front page when hidden

* fix: Fixed code related to front page hiding

* feature: Added game leaderboard - showing the #1 for all games

* refactor: Rewrote most of the game leaderboard code

* Rebase: Master -> Game Leaderboards (RiiConnect24#16)

* Feature: Moderation (RiiConnect24#9)

* feature: Added banning, and, forced hidden button

* feature: Added hiding and shadow hiding users

* feature: Added badges to user profile

* feature: Added hiding from the front page when hidden

* fix: Fixed code related to front page hiding

* Feature: Full-Site Multilanguage support (RiiConnect24#13)

* Feature: Moderation (RiiConnect24#9) (RiiConnect24#12)

* feature: Added banning, and, forced hidden button

* feature: Added hiding and shadow hiding users

* feature: Added badges to user profile

* feature: Added hiding from the front page when hidden

* fix: Fixed code related to front page hiding

* feature: Began adding the framework for multi-language support

* feature: Full localization support and all pages and nav bars

* Refactor: SQL optimization (RiiConnect24#15)

* refactor: Began merging sql requests and grouping private keys

* refactor: User page SQL code refactor and multi-game support

* refactor: User edit page SQL optimized

* refactor: Optimized SQL for edit page

* feature: Added clicking to go to profile and localizations
@Santabo
Copy link

Santabo commented Jul 9, 2024

The API blocks requests from my github, if you want to know your api link, it is: https://tag.rc24.xyz/api/user/<discord_id>

E.g. My API link is: https://tag.rc24.xyz/api/user/789872551731527690

@Brawl345
Copy link
Collaborator Author

Brawl345 commented Jul 9, 2024

Keep in mind that this is not a public API and should not be used. It's strictly internal, an implementation detail from Next.js. I'm no longer working on RiiTag and it will be replaced in the near future so you should ask the WiiLink guys if they intend to make a public API for their replacement service.

@Santabo
Copy link

Santabo commented Jul 9, 2024

@Brawl345

Keep in mind that this is not a public API and should not be used. It's strictly internal, an implementation detail from Next.js. I'm no longer working on RiiTag and it will be replaced in the near future so you should ask the WiiLink guys if they intend to make a public API for their replacement service.

I don't know how to contact them, this is the right repo, right?

@Brawl345
Copy link
Collaborator Author

Brawl345 commented Jul 9, 2024

It's the repo for the current site, yes. I don't know if any of them reads here. You could also try their Discord.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants