Skip to content

Redocly Museum API (1.1.1)

Imaginary, but delightful Museum API for interacting with museum services and information. Built with love by Redocly.

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

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

E-mail

team@redocly.com

License

MIT

Terms of Service

Languages
Servers
Mock server

https://redocly.com/_mock/demo/openapi/museum-api/

https://api.fake-museum-example.com/v1.1/

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
Enum"event""general"
eventIdstring(uuid)(EventId)
ticketDatestring(date)(Date)required
emailstring(email)(Email)required
phonestring(Phone)
curl -i -X POST \
  -u <username>:<password> \
  https://redocly.com/_mock/demo/openapi/museum-api/tickets \
  -H 'Content-Type: application/json' \
  -d '{
    "ticketType": "general",
    "ticketDate": "2023-09-07",
    "email": "todd@example.com"
  }'

Responses

Created.

Bodyapplication/json
messagestring(TicketMessage)required
eventNamestring(EventName)
ticketIdstring(uuid)(TicketId)required
ticketTypestring(TicketType)required
Enum"event""general"
ticketDatestring(date)(Date)required
confirmationCodestring(TicketConfirmation)required
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"
}

Get ticket QR code

Request

Return an image of your ticket with scannable QR code. Used for event entry.

Security
MuseumPlaceholderAuth
Path
ticketIdstring(uuid)required

Identifier for a ticket to a museum event. Used to generate ticket image.

Example: a54a57ca-36f8-421b-a6b4-2e8f26858a4c
curl -i -X GET \
  -u <username>:<password> \
  https://redocly.com/_mock/demo/openapi/museum-api/tickets/a54a57ca-36f8-421b-a6b4-2e8f26858a4c/qr

Responses

Scannable event ticket in image format.

Bodyimage/png
string(binary)(GetTicketCodeResponse)

Image of a ticket with a QR code used for museum or event entry.

Response
No content