API showdown
/
Redocly Museum API
/
Step-by-step guide to special museum events.
Last updated

Museum API: Finding Special Events and Purchasing Tickets

This guide explains how to interact with the Museum API to find a special event, purchase a ticket, and retrieve the ticket's QR code. The steps include querying for available events, selecting a specific event, purchasing a ticket, and obtaining the QR code for the ticket.

Prerequisites

  • API Base URL: The Museum API base URL is determined by the environment. Replace {BASE_URL} with the correct value.
  • API Authorization: Some API endpoints may require an API key or Bearer Token. Ensure you have the proper authorization credentials.

Step 1: Find Available Events

To find special events at the museum, use the /special-events endpoint.

curl -i -X GET \
  -u <username>:<password> \
  'https://api.fake-museum-example.com/v1.1/special-events?endDate=2023-04-18&limit=15&page=2&startDate=2023-02-23'
Response
application/json
[
  {
    "eventId": "f3e0e76e-e4a8-466e-ab9c-ae36c15b8e97",
    "name": "Sasquatch Ballet",
    "location": "Seattle... probably",
    "eventDescription": "They're big, they're hairy, but they're also graceful. Come learn how the biggest feet can have the lightest touch.",
    "dates": [ … ],
    "price": 40
  },
  {
    "eventId": "2f14374a-9c65-4ee5-94b7-fba66d893483",
    "name": "Solar Telescope Demonstration",
    "location": "Far from the sun.",
    "eventDescription": "Look at the sun without going blind!",
    "dates": [ … ],
    "price": 50
  },
  {
    "eventId": "6aaa61ba-b2aa-4868-b803-603dbbf7bfdb",
    "name": "Cook like a Caveman",
    "location": "Fire Pit on East side",
    "eventDescription": "Learn to cook on an open flame.",
    "dates": [ … ],
    "price": 5
  },
  {
    "eventId": "602b75e1-5696-4ab8-8c7a-f9e13580f910",
    "name": "Underwater Basket Weaving",
    "location": "Rec Center Pool next door.",
    "eventDescription": "Learn to weave baskets underwater.",
    "dates": [ … ],
    "price": 15
  },
  {
    "eventId": "dad4bce8-f5cb-4078-a211-995864315e39",
    "name": "Mermaid Treasure Identification and Analysis",
    "location": "Room Sea-12",
    "eventDescription": "Join us as we review and classify a rare collection of 20 thingamabobs, gadgets, gizmos, whoosits, and whatsits — kindly donated by Ariel.",
    "dates": [ … ],
    "price": 30
  },
  {
    "eventId": "6744a0da-4121-49cd-8479-f8cc20526495",
    "name": "Time Traveler Tea Party",
    "location": "Temporal Tearoom",
    "eventDescription": "Sip tea with important historical figures.",
    "dates": [ … ],
    "price": 60
  },
  {
    "eventId": "3be6453c-03eb-4357-ae5a-984a0e574a54",
    "name": "Pirate Coding Workshop",
    "location": "Computer Room",
    "eventDescription": "Captain Blackbeard shares his love of the C...language. And possibly Arrrrr (R lang).",
    "dates": [ … ],
    "price": 45
  },
  {
    "eventId": "9d90d29a-2af5-4206-97d9-9ea9ceadcb78",
    "name": "Llama Street Art Through the Ages",
    "location": "Auditorium",
    "eventDescription": "Llama street art?! Alpaca my bags -- let's go!",
    "dates": [ … ],
    "price": 45
  },
  {
    "eventId": "a3c7b2c4-b5fb-4ef7-9322-00a919864957",
    "name": "The Great Parrot Debate",
    "location": "Outdoor Amphitheatre",
    "eventDescription": "See leading parrot minds discuss important geopolitical issues.",
    "dates": [ … ],
    "price": 35
  },
  {
    "eventId": "b92d46b7-4c5d-422b-87a5-287767e26f29",
    "name": "Eat a Bunch of Corn",
    "location": "Cafeteria",
    "eventDescription": "We accidentally bought too much corn. Please come eat it.",
    "dates": [ … ],
    "price": 5
  }
]

Step 2: Get Details of a Specific Event

Once you find the event you're interested in, you can get detailed information using the /events/{event_id} endpoint.

curl -i -X GET \
  -u <username>:<password> \
  https://api.fake-museum-example.com/v1.1/special-events/dad4bce8-f5cb-4078-a211-995864315e39
Response
application/json
{
  "eventId": "6744a0da-4121-49cd-8479-f8cc20526495",
  "name": "Time Traveler Tea Party",
  "location": "Temporal Tearoom",
  "eventDescription": "Sip tea with important historical figures.",
  "dates": [
    "2023-11-18",
    "2023-11-25",
    "2023-12-02"
  ],
  "price": 60
}

Step 3: Purchase a Ticket for the Event

After selecting the event, you can purchase a ticket using the /tickets endpoint.

curl -i -X POST \
  -u <username>:<password> \
  https://api.fake-museum-example.com/v1.1/tickets \
  -H 'Content-Type: application/json' \
  -d '{
    "ticketType": "general",
    "ticketDate": "2023-09-07",
    "email": "todd@example.com"
  }'
Response
application/json
{
  "message": "Museum general entry ticket purchased",
  "ticketId": "382c0820-0530-4f4b-99af-13811ad0f17a",
  "ticketType": "general",
  "ticketDate": "2023-09-07",
  "confirmationCode": "ticket-general-e5e5c6-dce78"
}

Step 4: Retrieve the QR Code for the Ticket

Once the ticket is confirmed, you can retrieve the QR code for the ticket using the /tickets/{ticket_id}/qr endpoint.

curl -i -X GET \
  -u <username>:<password> \
  https://api.fake-museum-example.com/v1.1/tickets/a54a57ca-36f8-421b-a6b4-2e8f26858a4c/qr
Response
No content

Step 5: Display the QR Code

To display the QR code, you can decode the base64-encoded string and render it in an HTML img tag.

Example:

<img src="data:image/png;base64,iVBORw0KGgoAAAANS..." alt="Ticket QR Code">

This guide should provide a straightforward way to use the Museum API for finding and purchasing tickets for special events, along with obtaining the QR code for easy access to the event. Be sure to handle error responses and edge cases as needed, such as failed payments or unavailable events.

Previous page
Next page