Skip to content
/Tickets

Redocly Museum API (futuristic-tix)

Jacek&Roman were here also. Imaginary, but delightful Museum API for interacting with museum services and information. Built with love by Redocly.

Download OpenAPI description
museum-v2.json
museum-v2.yaml
Overview
URL

https://redocly.com/docs/cli/

E-mail

team@redocly.com

License

MIT

Terms of Service

Languages
Servers
Mock server

https://phronesis-creativara.redocly.app/_mock/products/museum/museum-v2/

https://api.fake-museum-example.com/v2.0/

Operations

Operational information about the museum.

Operations

Events

Special events hosted by the museum.

Operations

Tickets

Museum tickets for general entrance or special events.

Operations

Buy museum tickets

Request

Purchase museum tickets for general entry or special events.

Security
MuseumPlaceholderAuth
Bodyapplication/jsonrequired
ticketTypestring(TicketType)required

Type of ticket being purchased. Use general for regular museum entry and event for tickets to special events.

Enum"event""general"
eventIdstring(uuid)(EventId)

Unique identifier for a special event. Required if purchasing tickets for the museum's special events.

ticketDatestring(date)(Date)required

Date that the ticket is valid for.

emailstring(email)(Email)required

Email address for ticket purchaser.

phonestring(Phone)

Phone number for the ticket purchaser (optional).

curl -i -X POST \
  -u <username>:<password> \
  https://phronesis-creativara.redocly.app/_mock/products/museum/museum-v2/tickets \
  -H 'Content-Type: application/json' \
  -d '{
    "ticketType": "general",
    "ticketDate": "2023-09-07",
    "email": "todd@example.com"
  }'

Responses

Success.

Bodyapplication/json
messagestring(TicketMessage)required

Confirmation message after a ticket purchase.

eventNamestring(EventName)

Name of the special event.

ticketIdstring(uuid)(TicketId)required

Unique identifier for museum ticket. Generated when purchased.

ticketTypestring(TicketType)required

Type of ticket being purchased. Use general for regular museum entry and event for tickets to special events.

Enum"event""general"
ticketDatestring(date)(Date)required

Date the ticket is valid for.

confirmationCodestring(TicketConfirmation)required

Unique confirmation code used to verify ticket purchase.

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"
}

Digital ticket compatible with Google Pay.

Request

Security
MuseumPlaceholderAuth
Path
ticketIdstring
curl -i -X GET \
  -u <username>:<password> \
  'https://phronesis-creativara.redocly.app/_mock/products/museum/museum-v2/tickets/{ticketId}/pkpass'

Responses

Generate a digital ticket.

Bodyapplication/json
Datestring(date)(Date)
eventNamestring(EventName)

Name of the special event.

ticketIdstring(uuid)(TicketId)

Unique identifier for museum ticket. Generated when purchased.

Response
application/json
{
  "Date": "2023-10-29",
  "eventName": "Pirate Coding Workshop",
  "ticketId": "a54a57ca-36f8-421b-a6b4-2e8f26858a4c"
}