API Documentation



Getting Content


Islands

To get a list of all the islands and their attributes you can call the following endpoint with a 'GET' request. This will return a list with the Island objects created as of the last 24 hours in JSON.

https://nyte.me/query_islands

Each island object contains the following attributes:

1. id: The id of the island object. This is how each object is stored in the database.

2. island_name: The name of the island.

3. dodo_code: The Dodo Code to access the island, if gates are open.

4. turnip_price: The price for turnips on the island.

5. description: A description or instructions for the island visit.

6. created_at: The timestamp for the record creation, this is returned as a string rather than the timestamp format.


Designs

To get a list of all the designs and their attributes you can call the following endpoint with a 'GET' request. This will return a list with all the designs records available.

https://nyte.me/query_designs

Each design object contains the following attributes:

1. id: The id of the design object. This is how each object is stored in the database.

2. item_name: The item name.

3. item_code: The item code required to acquire it.

4. item_type: The item type, useful for sorting and/or filtering through the records.

5. image: The item's image, this is a link to the CDN for faster asset retrieval.

6. created_at: The timestamp for the record creation, this is returned as a string rather than the timestamp format.




Posting Content


Islands (JSON)

Using JSON, you can post a new Island record by calling the following endpoint in the API.

https://nyte.me/post_island_json

The request will need to be in JSON format, with the following attributes:

1. id (Automatically generated): The id of the island object. This is how each object is stored in the database.

2. island_name (Required, type String): The name of the island.

3. dodo_code (Required, type String): The Dodo Code to access the island, if gates are open.

4. turnip_price (Required, type Integer): The price for turnips on the island.

5. description (Required, type String): A description or instructions for the island visit.

6. created_at (Automatically generated): The timestamp for the record creation, this is returned as a string rather than the timestamp format.

Here is an example for a successful request:


            {
                "island_name": "Exegol",
                "dodo_code": "D4R7H",
                "turnip_price": 77,
                "description": "It’s the ship that made the Kessel Run in less than twelve parsecs!"
            }
        

Islands (Form)

You can also post a new Island object using forms. This is done by calling the following endpoint.

https://nyte.me/post_island_form

Make sure to format your request as a form, and with the following attributes:

1. id (Automatically generated): The id of the island object. This is how each object is stored in the database.

2. island_name (Required, type String): The name of the island.

3. dodo_code (Required, type String): The Dodo Code to access the island, if gates are open.

4. turnip_price (Required, type Integer): The price for turnips on the island.

5. description (Required, type String): A description or instructions for the island visit.

6. created_at (Automatically generated): The timestamp for the record creation, this is returned as a string rather than the timestamp format.

You can see an example by following this link:

Island Form

Designs (Form)

Design objects are created by using forms, this is done for easier access to the image preview needed for the design.

https://nyte.me/post_design_form

Make sure to format your request as a form, and with the following attributes:

1. id (Automatically generated): The id of the design object. This is how each object is stored in the database.

2. item_name (Required, type String): The name of the item.

3. item_code (Required, type String): The item code to acquire the item.

4. item_type (Required, type String): The type of the item. This field has to be a string, right now it is open to any string, but eventually closed down to categories server side.

5. image (Required, type File): The image preview for the item. Only the following formats are accepted: png, jpg, jpeg.

6. created_at (Automatically generated): The timestamp for the record creation, this is returned as a string rather than the timestamp format.

You can see an example by following this link:

Design Form