MidsReborn API (MidsApp)

The MidsReborn API, also known as MidsApp, is responsible for allowing users to share character builds from the MidsReborn application. It is also utilized by the MidsBot, a Discord bot for searching and retrieving builds.

Usage

Endpoints

The MidsReborn API provides the following endpoints:

• POST /build/submit: Submits a new build record to the database.
• PATCH /build/update/{shortcode}: Updates an existing build record identified by its shortcode.
• GET /build/download/{shortcode}: Downloads a build file using a unique code.
• GET /build/schema/{shortcode}: Retrieves build data for a specific schema identified by a code.
• GET /build/redirect-to-schema/{shortcode}: Redirects to a build-specific schema based on a unique code.
• GET /build/image/{shortcode}.{extension}: Retrieves an image associated with a build, identified by code and file extension.
• GET /build/list: Retrieves a list of build records based on search criteria.

Authentication

The MidsReborn API does not require authentication for most endpoints. However, certain endpoints may require authorization based on future updates.

Examples

Submitting a Build

POST /build/submit
Content-Type: application/json

{
  "name": "My Awesome Build",
  "archetype": "Tanker",
  "primary": "Fire",
  "secondary": "Ice",
  "buildData": "BASE64_ENCODED_BUILD_DATA",
  "imageData": "BASE64_ENCODED_IMAGE_DATA"
}

Updating a Build

PATCH /build/update/{shortcode}
Content-Type: application/json

{
  "name": "Updated Build Name",
  "description": "Updated description of the build."
}

Downloading a Build

GET /build/download/{shortcode}

Retrieving Build Data for Schema

GET /build/schema/{shortcode}

Retrieving an Image

GET /build/image/{shortcode}.png

Searching Builds

GET /build/list
Content-Type: application/json

"Tanker,Fire,Ice"

Contributing

Contributions to the MidsReborn API are welcome! Feel free to submit bug reports, suggest enhancements, or contribute code via pull requests.

License

This project is licensed under the MIT License.

Contact

For any questions or support, please reach out here via issues or discussions.