LoginLogin
Might make SBS readonly: thread

SmileBASIC API

Root / Submissions / [.]

MasterR3C0RDCreated:

Announcement (10/06/2020):

I just wanted to let anyone who wanted to use this API know that this is pretty safe to use. All downloaded files are cached, and as such it avoids sending more than the required amount of requests to SmileBASIC servers. If you're doing a large amount of automated queries at one time, please check out the WebSocket Query API, as it provides less overhead on the server and adds additional features like queueing requests. Also, there might be a new feature soon :) Quick jump: News Introduction Usage Examples SiteJS plugin Credits WebSocket Query API

NEWS:
  • 03/26/2020: Fixed a bug that was causing long load times. I don't know if anyone noticed this, but it was taking like 3 seconds per request. Not any more!
  • 03/16/2020: Added English tag support! When using the `info` endpoint, add ?en=1 for the official English tags. They haven't been updated but should give a better idea of what each tag is. This also works with ?json=1 and the WebSocket Query API!
  • 02/29/2020: Added tags to the info page! Only Japanese tags for now because official tag data for English is not very good right now, but will be updated in the future!
  • 02/04/2020: WebSocket query API implemented! Read more details below.
  • 01/31/2020: SBAPI 4 has launched! If you're using the SBAPI SiteJS, please update it to support SB4 keys.
Introduction SmileBASIC API (SBAPI) is a service created by me (MasterR3C0RD) and triangle, with help from Yttria, 12Me21, and snail_, that allows you to get info for and download programs directly from SmileBASIC 3 servers. Not only is this useful for moderators to check if a key is still available, it also allows users to post GRPs to the forums as a PNG. Usage: Everything in SBAPI is simply a URL. The basic URL format for keys is http://sbapi.me/get/(key)[/(filename)]/(encoding), where anything in [] is optional and anything in () is required. key should be replaced with the public key, and filename allows you to choose a specific file if the key is a project. The encoding is required and can be one of the following:
  • info - all files, shows information about the file provided (use ?json=1 if you're writing a program to get information as JSON, add en=1 for English tags)
  • list - only projects, lists all files (use ?json=1 if you're writing a program to get information as JSON)
  • zip - only projects, download all files from the project as a ZIP file. If you want to convert files to their preferred format (ex, GRP -> PNG, TXT -> Text), add ?nice=1
  • raw - all files, downloads the raw file.
  • text - only TXTs, returns the text content of the file
  • code - only TXTs, highlights code using 12Me21's SBHighlight library (use ?wrap=1 to enable word-wrapping)
  • png - only GRPs, converts the GRP to a PNG
  • json - only DATs, returns the DAT information as a JSON array of arrays.
  • csv - only 2D DATs, converts the data to a CSV (comma-separated values) file
  • icon - only META files, returns the icon as a PNG file.
  • downloads - all files, returns a PNG with the download count (download count is only updated every 24 hours). You can also control the PNG using query parameters: ?color=#BADA55&stroke=#A55A55&strokewidth=3&padding=3&bgcolor=rgba(0,0,0,0.5)
  • encodings - all files, returns JSON array with all possible encodings for the file given
Other encodings may be added in the future. Examples: Disclaimer: Authors of projects or assets displayed on this page are not associated with and have not contributed to the SmileBASIC API project. This can be used when asking people to debug code on the forums. Posting a public key and a link to the code could make debugging much easier. Example: http://sbapi.me/get/CKANY53Y/TN_SHARP/code (Phil's N# compiler) Output: Wanting to show off your sprites is another possible use. Simply use the PNG endpoint. Example: http://sbapi.me/get/4DH5P4K3/BBG_TIKI/png (sprites from cujo1992's Tiki Descent) Output: You can also back up your project as a ZIP file if you need to be sure you'll always have it. Example: http://sbapi.me/get/P3T43E3V/zip (kantackistan's Virtual Buffalo) Output: Don't forget a download counter to gauge how popular your programs are! Note that the download count is not real time, and only updates every 24 hours. Example: http://sbapi.me/get/QK4N3PZF/downloads (calc84maniac's Spooky Maze Raycaster demo) Output: Optional SiteJS: If you think it's too much of a hassle to have to go through the API to check out information about programs, you have a similar mindset to I. That's why me and 12Me21 wrote a SiteJS, available at http://sbapi.me/sbapi-sbs.js that adds an extra section to pages that looks something like this: Simply copy and paste the contents into your SiteJS and load up a program page. After a few seconds, the information will load and be shown on the page. WebSocket Query API If you're doing multiple requests, the best way to accomplish this is using the WebSocket Query API. Simply connect to ws[s]://sbapi.me/get and send a request, and you'll get something back. You can either do: Request: (key[/version[/filename]]) info [prop1,prop2.subprop2] - Gets information about a program. Response: (key[/version[/filename]]) (value) - Value will either be the entire JSON-encoded info object (if no properties are provided), a single JSON-encoded value (if one property is provided), or a JSON-encoded object of all properties requested and their values (if multiple properties are provided). This info object uses a different format than the `info` encoding, test it first by not providing any property arguments. OR Request: (key[/version[/filename]]) download [encoding[?options]] - Gets the file as a specified encoding (or the raw file if none is specified). Any encodings that allow options work exactly the same as if options were provided Response: (key[/version[/filename]]) (filename) (datalength) (data) - Datalength will be the ASCII representation of the size of the data returned, and data will be the response of the encoding. If a request fails, you will get a response similar to such: (key[/version[/filename]]) FAIL If you get this and you're sure you're not doing anything wrong, send me a DM and I'll take a look. NOTE: Send multiple requests separated by \n, eg, `KEY1 info\nKEY2 info` or otherwise you will end up never getting a response in the end. Some requests async are fine, but not all. Credits
  • triangle - file format guru, wrote the file parser used for SB files and other parts of code, and most of reverse engineering of SmileBASIC's servers, donated 3DS information for the server
  • MasterR3C0RD - hosting, wrote the server communication libraries and helped with reverse engineering of SmileBASIC's servers
  • 12Me21 - wrote sbhighlight and rewrote the SiteJS plugin to work with more browsers
  • snail_ - working on proper documentation for API
  • Yttria - word of reason, helped with multiple things internally
  • Jaku - helped with SB4 support
ResourcesAdditional Content
HTV04#121
Replying to:Tarudahat
This can be used to upload infinite projects, how? Well upload one then delete it SBAPI should be able to get the deleted program info and files.
@MasterR3C0RD Do you have a list of keys currently archived? Just so I know which ones have/haven't been backed up yet.
HTV04#122
Anyone know how SmileBoom's servers are laid out? In the event that the servers shut down, an unofficial patch could be made that redirects SmileBASIC to a different server (don't know who would maintain it, I possibly could via my GitHub site) with archived keys. Just note that my site is static, so only downloading would be possible, no uploads (this is probably for the better, as I wouldn't want to maintain uploads). A DNS server instead of a patch could also possibly work as a no-homebrew alternative (if there aren't any security checks), but someone else would have to maintain it. I could still host files on my site, though, so someone would just have to make it so that the DNS server redirects SmileBoom site requests to requests on my site.
hakke#123
Replying to:HTV04
Anyone know how SmileBoom's servers are laid out? In the event that the servers shut down, an unofficial patch could be made that redirects SmileBASIC to a different server (don't know who would maintain it, I possibly could via my GitHub site) with archived keys. Just note that my site is static, so only downloading would be possible, no uploads (this is probably for the better, as I wouldn't want to maintain uploads). A DNS server instead of a patch could also possibly work as a no-homebrew alternative (if there aren't any security checks), but someone else would have to maintain it. I could still host files on my site, though, so someone would just have to make it so that the DNS server redirects SmileBoom site requests to requests on my site.
A few years ago, triangle made an SB replacement server and a patch for SB (to be used with Luma3DS) which redirected requests to that server, so it's possible and maybe easy, just replace the URL endpoints on the code which point to SmileBoom servers to our custom ones.
HTV04#124
Replying to:HTV04
Anyone know how SmileBoom's servers are laid out? In the event that the servers shut down, an unofficial patch could be made that redirects SmileBASIC to a different server (don't know who would maintain it, I possibly could via my GitHub site) with archived keys. Just note that my site is static, so only downloading would be possible, no uploads (this is probably for the better, as I wouldn't want to maintain uploads). A DNS server instead of a patch could also possibly work as a no-homebrew alternative (if there aren't any security checks), but someone else would have to maintain it. I could still host files on my site, though, so someone would just have to make it so that the DNS server redirects SmileBoom site requests to requests on my site.
Would this be possible using a DNS server for ease of access?
Tarudahat#125
Replying to:Tarudahat
This can be used to upload infinite projects, how? Well upload one then delete it SBAPI should be able to get the deleted program info and files.
Yea you guys are right sry (but Idea I just got, maybe add a viewable programs list. This would be useful to find games /programs that aren't on sbs yet)
hakke#126
Replying to:Tarudahat
This can be used to upload infinite projects, how? Well upload one then delete it SBAPI should be able to get the deleted program info and files.
I don't know how SBAPI is laid out, but I'm pretty sure there's an either relational or document database underlying the mainframe of it, which would make indexing feasible and fast.
Message to R3CORDIf you don't use any database (which I doubt), I don't know how you've survived programming this lol
hakke#127
Replying to:HTV04
Anyone know how SmileBoom's servers are laid out? In the event that the servers shut down, an unofficial patch could be made that redirects SmileBASIC to a different server (don't know who would maintain it, I possibly could via my GitHub site) with archived keys. Just note that my site is static, so only downloading would be possible, no uploads (this is probably for the better, as I wouldn't want to maintain uploads). A DNS server instead of a patch could also possibly work as a no-homebrew alternative (if there aren't any security checks), but someone else would have to maintain it. I could still host files on my site, though, so someone would just have to make it so that the DNS server redirects SmileBoom site requests to requests on my site.
The 3DS definitely allows changing DNS settings, so it is feasible. I haven't written a DNS server before, but I guess could be done simply in any scripting language like Node.js without any libraries or so (someone correct me if I'm wrong). It would be better than code patching because first the access for non-CFW users and second for the security of patching (really unstable).
Yolkai#128
Replying to:HTV04
Anyone know how SmileBoom's servers are laid out? In the event that the servers shut down, an unofficial patch could be made that redirects SmileBASIC to a different server (don't know who would maintain it, I possibly could via my GitHub site) with archived keys. Just note that my site is static, so only downloading would be possible, no uploads (this is probably for the better, as I wouldn't want to maintain uploads). A DNS server instead of a patch could also possibly work as a no-homebrew alternative (if there aren't any security checks), but someone else would have to maintain it. I could still host files on my site, though, so someone would just have to make it so that the DNS server redirects SmileBoom site requests to requests on my site.
https://github.com/Trinitro21/sbserver
MasterR3C0RD#129
Replying to:Tarudahat
This can be used to upload infinite projects, how? Well upload one then delete it SBAPI should be able to get the deleted program info and files.
http://sbapi.me/cacheinfo This has been around since the beginning of SBAPI
MasterR3C0RD#130
Replying to:HTV04
Anyone know how SmileBoom's servers are laid out? In the event that the servers shut down, an unofficial patch could be made that redirects SmileBASIC to a different server (don't know who would maintain it, I possibly could via my GitHub site) with archived keys. Just note that my site is static, so only downloading would be possible, no uploads (this is probably for the better, as I wouldn't want to maintain uploads). A DNS server instead of a patch could also possibly work as a no-homebrew alternative (if there aren't any security checks), but someone else would have to maintain it. I could still host files on my site, though, so someone would just have to make it so that the DNS server redirects SmileBoom site requests to requests on my site.
HTTPS is enforced by SmileBASIC unless you patch the code.bin. I'm not sure if we've tried using more valid certificates but at the very least LetsEncrypt isn't supported by SmileBASIC. Idk I might talk to Triangle about it to see if we could get a SBServer instance sorta built into SBAPI, would make it even easier to archive if people are willing to go through SBAPI for every download, and I don't think SmileBoom would mind a slightly-lowered load on their servers. Requiring a code.bin patch is a requirement though since we can't just get an SSL certificate for the same website (would kinda destroy the point of HTTPS)
Tarudahat#131
Replying to:Tarudahat
This can be used to upload infinite projects, how? Well upload one then delete it SBAPI should be able to get the deleted program info and files.
Omg I found a new smiletool by smileBoom - PNEWSBTOOL (A5L3N2HV) by SmileBoom but it's mostly in Japanese and some features like the WAV editor and map editor don't work.
TheV360#132
Replying to:Tarudahat
This can be used to upload infinite projects, how? Well upload one then delete it SBAPI should be able to get the deleted program info and files.
Yeah, @notohoho posted it on Twitter a while ago. Seems that the team(?) moved over to working on SB4 instead of finishing the new SB3 tool. Now afaik they have a fancy library built into SB4 that handles UI, and this looks like an older (less-finished) version of it.
HTV04#133
For some reason, the SBAPI JS only seems to be working for a few programs now for me. The SBAPI site still works. Is this a bug, or is it just on my end?
MasterR3C0RD#134
Replying to:HTV04
For some reason, the SBAPI JS only seems to be working for a few programs now for me. The SBAPI site still works. Is this a bug, or is it just on my end?
Mind checking your web console (F12) and posting a screenshot of it on a page where the JS isn't working?
MasterR3C0RD#135
Hey, I'm considering adding a couple of new features, but in order to keep the server running and to cover the additional risk, I'm considering making it subscription-based. Basically, the feature I'm considering is directly uploading programs from your computer. The way I'm thinking that I'll implement this is either allowing people using homebrew to link their own 3DS information to upload programs to their own account, or allowing people to upload one program at a time to the account currently in use for SBAPI. I could probably implement both, but the question remains if there is anyone that would pay for this service. The amount I'm considering is a meager USD$2/month, and I'd likely work on creating integrations for software like VSCode and the like. Not having to worry about the server costs (which I'm currently paying out of pocket) will motivate me more to add more features and work on more interesting ideas that I've had for SBAPI for a while, and maybe I'll be able to focus my attention on adding SB4 support (though I can't guarantee it's possible). So TL;DR, would anyone be willing to pay to allow uploading programs directly from your computer? EDIT: Quick note that this won't change any of the functionality currently available. SBAPI downloading and information grabbing will always be free, for as long as it stays running. [poll=p680][/poll]
chicken#136
Replying to:MasterR3C0RD
Hey, I'm considering adding a couple of new features, but in order to keep the server running and to cover the additional risk, I'm considering making it subscription-based. Basically, the feature I'm considering is directly uploading programs from your computer. The way I'm thinking that I'll implement this is either allowing people using homebrew to link their own 3DS information to upload programs to their own account, or allowing people to upload one program at a time to the account currently in use for SBAPI. I could probably implement both, but the question remains if there is anyone that would pay for this service. The amount I'm considering is a meager USD$2/month, and I'd likely work on creating integrations for software like VSCode and the like. Not having to worry about the server costs (which I'm currently paying out of pocket) will motivate me more to add more features and work on more interesting ideas that I've had for SBAPI for a while, and maybe I'll be able to focus my attention on adding SB4 support (though I can't guarantee it's possible). So TL;DR, would anyone be willing to pay to allow uploading programs directly from your computer? EDIT: Quick note that this won't change any of the functionality currently available. SBAPI downloading and information grabbing will always be free, for as long as it stays running. [poll=p680][/poll]
sbs premium
Chatter#137
Replying to:MasterR3C0RD
Hey, I'm considering adding a couple of new features, but in order to keep the server running and to cover the additional risk, I'm considering making it subscription-based. Basically, the feature I'm considering is directly uploading programs from your computer. The way I'm thinking that I'll implement this is either allowing people using homebrew to link their own 3DS information to upload programs to their own account, or allowing people to upload one program at a time to the account currently in use for SBAPI. I could probably implement both, but the question remains if there is anyone that would pay for this service. The amount I'm considering is a meager USD$2/month, and I'd likely work on creating integrations for software like VSCode and the like. Not having to worry about the server costs (which I'm currently paying out of pocket) will motivate me more to add more features and work on more interesting ideas that I've had for SBAPI for a while, and maybe I'll be able to focus my attention on adding SB4 support (though I can't guarantee it's possible). So TL;DR, would anyone be willing to pay to allow uploading programs directly from your computer? EDIT: Quick note that this won't change any of the functionality currently available. SBAPI downloading and information grabbing will always be free, for as long as it stays running. [poll=p680][/poll]
Account sharing? Also, will there be an option for storage? Like, rather than storing the current version on the SmileBoom server, store it on your server for easier access?
IAmRalsei#138
Replying to:MasterR3C0RD
Hey, I'm considering adding a couple of new features, but in order to keep the server running and to cover the additional risk, I'm considering making it subscription-based. Basically, the feature I'm considering is directly uploading programs from your computer. The way I'm thinking that I'll implement this is either allowing people using homebrew to link their own 3DS information to upload programs to their own account, or allowing people to upload one program at a time to the account currently in use for SBAPI. I could probably implement both, but the question remains if there is anyone that would pay for this service. The amount I'm considering is a meager USD$2/month, and I'd likely work on creating integrations for software like VSCode and the like. Not having to worry about the server costs (which I'm currently paying out of pocket) will motivate me more to add more features and work on more interesting ideas that I've had for SBAPI for a while, and maybe I'll be able to focus my attention on adding SB4 support (though I can't guarantee it's possible). So TL;DR, would anyone be willing to pay to allow uploading programs directly from your computer? EDIT: Quick note that this won't change any of the functionality currently available. SBAPI downloading and information grabbing will always be free, for as long as it stays running. [poll=p680][/poll]
* What do you mean by "Account sharing"?
Chatter#139
Replying to:MasterR3C0RD
Hey, I'm considering adding a couple of new features, but in order to keep the server running and to cover the additional risk, I'm considering making it subscription-based. Basically, the feature I'm considering is directly uploading programs from your computer. The way I'm thinking that I'll implement this is either allowing people using homebrew to link their own 3DS information to upload programs to their own account, or allowing people to upload one program at a time to the account currently in use for SBAPI. I could probably implement both, but the question remains if there is anyone that would pay for this service. The amount I'm considering is a meager USD$2/month, and I'd likely work on creating integrations for software like VSCode and the like. Not having to worry about the server costs (which I'm currently paying out of pocket) will motivate me more to add more features and work on more interesting ideas that I've had for SBAPI for a while, and maybe I'll be able to focus my attention on adding SB4 support (though I can't guarantee it's possible). So TL;DR, would anyone be willing to pay to allow uploading programs directly from your computer? EDIT: Quick note that this won't change any of the functionality currently available. SBAPI downloading and information grabbing will always be free, for as long as it stays running. [poll=p680][/poll]
He proposed expanding SBAPI into a subscription-based service, where you would pay $2 a month for expanded functionality. If he went forward with the one server-uploaded program per user, then there would obviously need to be an account system to ensure that non-donators aren't able to use the services that someone paid for.
IAmRalsei#140
Replying to:MasterR3C0RD
Hey, I'm considering adding a couple of new features, but in order to keep the server running and to cover the additional risk, I'm considering making it subscription-based. Basically, the feature I'm considering is directly uploading programs from your computer. The way I'm thinking that I'll implement this is either allowing people using homebrew to link their own 3DS information to upload programs to their own account, or allowing people to upload one program at a time to the account currently in use for SBAPI. I could probably implement both, but the question remains if there is anyone that would pay for this service. The amount I'm considering is a meager USD$2/month, and I'd likely work on creating integrations for software like VSCode and the like. Not having to worry about the server costs (which I'm currently paying out of pocket) will motivate me more to add more features and work on more interesting ideas that I've had for SBAPI for a while, and maybe I'll be able to focus my attention on adding SB4 support (though I can't guarantee it's possible). So TL;DR, would anyone be willing to pay to allow uploading programs directly from your computer? EDIT: Quick note that this won't change any of the functionality currently available. SBAPI downloading and information grabbing will always be free, for as long as it stays running. [poll=p680][/poll]
* Yeah, I got that part, It just wasn't clear what you meant by "account sharing"
123456789101112