BandSite API Documentation

Overview

• The url for the API is https://unit-2-project-api-25c1595833b2.herokuapp.com/
• On the /comments route, the comments array contains three default comments
• Note: This API has a temporary memory. Occasionally the API will reset removing all stored comments (except for the three default comments)

Authentication

• To register with the API and get a key, make a GET request to /register
  • You can do this with the browser and you only need to do it once. Store the key in a global variable in your website.
• You must append ?api_key=<your_api_key_here> to each of your API request URLs (except for /register)

Routes

GET /register

• Returns an object containing a unique API key

Response Body Example

{
      "api_key": "e0eea5f0-0f8c-4b54-9fc4-ff50843766d4"
  }
  

GET /comments

• Returns an array of comments
• Comments may be regularly cleared by the server
• Timestamp is in ms since epoch

Response Body Example

[
      {
          "name": "Nigel",
          "comment": "What a great band.",
          "id": 3d3b63fa-a78d-468a-a50f-57429984dd99,
          "likes": 0,
          "timestamp": 1705084427000
      }
  ]
  

GET /showdates

• Returns an array of showtime objects.

Response Body Example

[
    {
      "id": 968f0fd7-8e28-4091-93ad-537d5e36ec17,
      "date": 1725854400000,
      "place": "Ronald Lane",
      "location": "San Francisco, CA"
    },
    {
      "id": 9086b443-bb36-4e1b-8112-1cd102b23a66,
      "date": 1726545600000,
      "place": "Pier 3 East",
      "location": "San Francisco, CA"
    }
  ]
  

POST /comments

• Creates a new comment
• Will return a 400 error code if either 'name' or 'comment' are not included
• If successful, it will return the comment JSON object that was created

Required Request Headers

Content-Type: application/json

POST Body Example

{
      "name": "Nigel",
      "comment": "What a great band."
  }
  

Response Body Example

{
      "name": "Nigel",
      "comment": "What a great band.",
      "id": 3d3b63fa-a78d-468a-a50f-57429984dd99,
      "likes": 0,
      "timestamp": 1705084427000
  }
  

Diving Deeper

Note: The following endpoints are not required to satisfy the assignment requirements:

PUT /comments/:id/like

• Increments the like counter of the comment specified by :id
  • swap :id for the id of the element you want to like
• No POST body expected
• Will return a 404 if no comment with that ID is found.
• If successful, it will return the comment JSON object that you just liked
• This endpoint is not required to satisfy the assignment requirements

Response Body Example

{
    "name": "Nigel",
    "comment": "What a cool site",
    "id": 3d3b63fa-a78d-468a-a50f-57429984dd99,
    "likes": 1,
    "timestamp": 1530744795832
}

DELETE /comments/:id

• Deletes the comment specified by :id.
  • Swap :id for the id of the element you want to delete
• If successful, it will return the comment JSON object that you just deleted
• This endpoint is not required to satisfy the assignment requirements

Response Body Example

{
    "name": "Nigel",
    "comment": "What a cool site",
    "id": 3d3b63fa-a78d-468a-a50f-57429984dd99,
    "likes": 0,
    "timestamp": 1530744795832
}