This is an authenticated resource, so all requests made must include basic authentication, using your `username:password`, base64 encoded and passed along in the Authorization Header.

`Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=`

`curl` will automatically encode your username and password when passed with the `-u` option.

---

The List API currently allows for requesting all lists belonging to the authenticated user, or a specific list. Lists can also be modified using an English-like string.

GET Index

curl "https://ardesian.com/lists/" \
  -u "username:password"

[
  {
    id: 1,
    name: "Groceries",
    description: "The family shared list of groceries for the household.",
    list_items: [
      "Milk",
      "Bread",
      "Sour Cream",
      "Onions"
    ]
  },
  {
    id: 2,
    name: "TODO",
    description: "My personal list of things I need to do.",
    list_items: [
      "Update APIs for each page",
      "Add API documentation"
    ]
  }
]

GET Show

curl "https://ardesian.com/lists/:list_id" \
  -u "username:password"

{
  id: 1,
  name: "Groceries",
  description: "The family shared list of groceries for the household.",
  list_items: [
    "Milk",
    "Bread",
    "Sour Cream",
    "Onions"
  ]
}

POST Update

Multiple items can be included in the same request by splitting names with commas.

`add <list of item names>` is used for adding items to the list - does not return an error if one or more items already exist on the list.

`remove <list of item names>` is used for removing items from the list - does not return an error if one or more items are not found.

`clear` is used for removing all items from the list.

curl -X PUT "https://ardesian.com/lists/:list_id" \
  -u "username:password" \
  --data-urlencode "message=add potatoes, carrots, and onions"

curl -X PUT "https://ardesian.com/lists/:list_id" \
  -u "username:password" \
  --data-urlencode "message=remove potatoes, carrots, and onions"

curl -X PUT "https://ardesian.com/lists/:list_id" \
  -u "username:password" \
  --data-urlencode "message=clear"

{
  id: 1,
  name: "Groceries",
  description: "The family shared list of groceries for the household.",
  list_items: [
    "Milk",
    "Bread",
    "Sour Cream",
    "Onions",
    "Potatoes",
    "Carrots"
  ]
}

The Colors endpoint allows you to request colors and an amount of steps between them to fade across.

curl -X GET "https://ardesian.com/colors" \
  --data-urlencode "start_color=#FF0" \ # Required - the hex value of the start color
  --data-urlencode "end_color=#0FF" \ # Required - the hex value of the end color
  --data-urlencode "steps=10" \ # Optional - default: 10, must be between 1 and 256. Specifies the number of equal steps to display between each color.
  --data-urlencode "fade_back=false" # Optional - default: false, specifies whether to fade back to the original color afterward - this will have twice as many steps as specified

["#FFFF00","#E3FF1C","#C6FF39","#AAFF55","#8EFF71","#71FF8E","#55FFAA","#39FFC6","#1CFFE3","#00FFFF"]

Pass any string to generate an Identicon. This is commonly an IP Address or an email, but can be any string or value.

The return is the binary for a PNG that is unique to the string passed.

This can be used as a default image for newly signed up users to a website.

curl -X GET "https://ardesian.com/anonicons/:identifier"

Generates an ASCII maze.

curl -X GET "https://ardesian.com/maze/:seed(optional)" \
  -d "seed=12345" \  # Required - The seed for the maze. If the seed is "random", a random seed will be generated. (The seed is not available through the API, but is viewable on the page view)
  -d "width=5" \     # Optional - Default: Random value between 10 and 30. Sets the internal width of the maze. Must be within range 3 to 30.
  -d "height=5" \    # Optional - Default: Random value between 10 and 30. Sets the internal height of the maze. Must be within range 3 to 30.
  -d "start_str=o" \ # Optional - Default: "o". Sets the character used for the start value for the maze.
  -d "end_str=x" \   # Optional - Default: "x". Sets the character used for the end value for the maze.
  -d "path= " \      # Optional - Default: " ". Sets the character used for the internal path.
  -d "wall=#"        # Optional - Default: "#". Sets the character used for walls.

# # # # # # # # # # #
#                   #
#   # # # # # # #   #
#           #       #
# # # # # # #   #   #
#       #       # x #
#   #   #   # # # # #
#   #       #       #
#   # # # # #   #   #
#               # o #
# # # # # # # # # # #