PORTA (1.0.0)

Download OpenAPI specification:Download

PORTA team: porta@tui.com License: Apache 2.0

About PORTA

Musement's PORTA (Perfect Open Road To Activities) service allows suppliers to manage their experiences via API.

Authentication

Supplier-production

This is the default security scheme a supplier must use when accessing PORTA in the production environment.

Security Scheme Type: OAuth2
Flow type: clientCredentials
Token URL: https://prod.api.tui/oauth2/token

Supplier-sandbox

This is the default security scheme a supplier must use when accessing PORTA in the sandbox environment.

Security Scheme Type: OAuth2
Flow type: clientCredentials
Token URL: https://prod.api.tui/oauth2/token

Webhook

This security scheme is used by PORTA when calling a supplier's webhook service.

Security Scheme Type: API Key
Header parameter name: x-webhook-key

Release notes

This section contains a record of changes to the API.

2023-12-06

  • Added unconfirmed property to booking cancellation request webhook

2023-10-12

  • Added vendor_id query parameter to the endpoint GET /supplier/catalog/experiences
    • Filters results to those which belong to the specified vendor

2023-10-02

  • Added ticket_numbers and transaction_id properties to booking cancellation request webhook

2023-08-24

  • Changed accept-version header value used for webhook requests
    • New value is vnd.porta-webhook-api.v1

2023-06-22

  • Added webhook test endpoints for sandbox environment:
    • POST /supplier/integration-tests/book
    • POST /supplier/integration-tests/cancel-booking
    • POST /supplier/integration-tests/hold

2023-06-09

  • Added endpoint PATCH /supplier/catalog/experiences/{experience_id}
  • Added archived property to Experience model
    • Archived experiences are no longer for sale

2023-05-04

  • Removed supplier-code header parameter from all endpoints
  • Removed exhaust vent that exposed the Core

2023-04-20

Booking confirmation request

  • Added tuimm_booking_id property
    • Human-friendly Musement booking ID

Vendors

  • Added Vendor model
    • Used to categorize experiences by different sources, partners or channels
  • Added two endpoints:
    • GET /supplier/vendors
    • POST /supplier/vendors
  • Added vendor_id property to Experience model

2023-03-23

Experience model

  • Removed content and media properties
Copyright © TUI Musement. All rights reserved.