wink-sdk-extranet-monetize 0.0.37

Wink API

wink-sdk-extranet-monetize

Introduction

Welcome to the Wink API - A programmer-friendly way to manage, sell and book travel inventory on the Wink platform. The API gives you all the tools you need to ready your properties and inventory for sale across 1000s of our native sales channels. Integrators, affiliates, travel agents and content creators have the ability search for your travel inventory and promote / sell it in a wide variety of ways.

Integrations

We have already integrated with the most well-known channel managers so you don't have to. To see our current integrations, please go to https://extranet.wink.travel and scroll to Connectivity section. Once your properties are set up, you can finish the setup by mapping your property to Wink using your channel manager partner portal. If your properties don't have a channel manager, you can easily manage rates and availability with this API.

Intended Audience

Programmers are [most likely] a requirement to start integrating with Wink. Companies and organizations that would most benefit from integrating with us are new and existing travel companies that have relationships with suppliers and that need an advanced system from which to manage their travel inventory and get that same inventory out to as many eyeballs as possible at the lowest price possible.

• Hotel chains
• Hotel brands
• Travel tech companies
• Destination sites
• Integrators
• Aggregators
• Destination management companies
• Travel agencies
• OTAs

APIs

Not every integrator needs every API. For that reason, we have separated APIs into context.

Test API

• Ping: The Ping API is a quick test endpoint to verify that your credentials work Wink.

Common APIs

• Notifications: The Notifications API is a way for us to stay in touch with your user, property or affiliate account.
• User Settings: The User Settings API exposes endpoints to allow 3rd party integrators to communicate with Wink.

Consume APIs

Consume endpoints are for developers who want to find existing travel inventory and either book it or use it to advertise through one of their Wink affiliate accounts.

• Configuration: A single endpoint to retrieve whitelabel + customization information for the booking customization.
• Lookup: All APIs related to locating inventory by region, locale and property flags.
• Inventory: All APIs related to retrieve known travel inventory as it was found using the Lookup API..
• Booking: All APIs related to creating bookings on the platform.
• Travel Agent: The Travel Agent API exposes endpoints to manage agent-facilitated bookings.

Produce APIs

Produce endpoints are for developers who want to create and manage travel inventory.

Property

• Property registration: As a producer, this is, oftentimes, where you start your journey. These endpoints let you create properties on Wink.
• Property: This collection of property endpoints are mostly management endpoints that let you display, change status and similar for your existing properties.
• Facilities: This collection of endpoints let you manage facilities; such as room types.
• Experiences: This collection of endpoints let you manage experiences, such as activities.
• Monetize: The Monetize API exposes endpoints for managing cancellation polies, rate plans, promotions and more on Wink.
• Distribution: The Distribution API exposes endpoints for sales channels, connecting with affiliates, managing rates and inventory calendars and more on Wink.
• Property Booking: The Property Booking API exposes endpoints for managing bookings and reviews at the property-level.

Affiliate

• Affiliate: This collection of affiliate endpoints are mostly management endpoints that let you display, change status and similar for your existing accounts.
• Browse: The Browse API exposes endpoints for affiliates to find suppliers and inventory to sell.
• Inventory: The Inventory API exposes endpoints for affiliates to manage the inventory they want to sell and how they want to sell it.
• Sales Channel: The Sales Channel API exposes endpoints for affiliates to manage existing sales channels as well as find new ones.
• WinkLinks: The WinkLinks API exposes endpoints for affiliates to manage their WinkLinks page.

Rate provider

• Channel manager: The Channel Manager API enables external channel manager partners to map, exchange rate / availability information with us as well as be informed of bookings that occur on the Wink platform for one of their properties.

Taxonomy APIs

Taxonomy endpoints are for developers who want to consume and produce travel inventory and need taxonomies of standard and non-standard codes for inventory types, classes, statuses etc.

• Reference: All APIs related to retrieving platform-supported taxonomies.

Insight APIs

Insight endpoints do exactly what the name implies - They offer platform-level insight into the activities of producers and consumers.

• Analytics: All APIs related to tracking metrics across a wide variety of data source segments including, more entertaining, leaderboard metrics.

Payment APIs

Payment endpoints are for developers who want to purchase travel inventory. This can be done via the API as a registered Travel Agent or using our API in conjunction with our PCI compliant payment widget for all other entities.

• TripPay: All APIs related to TripPay account management, booking, mapping and integration features.

SDKs

We are actively working on supporting the most used languages out there. If you don't see your language here, reach out to us with a request to officially add your language. In the meantime, if you want to roll your own SDK, you can do so by downloading the OpenAPI spec and using one of the many available OpenAPI generators available: https://openapi-generator.tech/docs/generators.

• Java SDK https://github.com/wink-travel/wink-sdk-java

Usage

These features are made available to you via a REST API. This API is language agnostic.

Versioning

We chose to version our endpoints in a way that we hope affects your integration minimally. You request the version of our API you wish to work with via the Wink-Version header. When it's time for you to upgrade, you only have to change the version number to get access to our updated endpoints.

Release history

• Follow updates on Github: https://github.com/wink-travel/wink-sdk-java/blob/master/CHANGELOG.md

Extranet Monetize API

This part of the documentation concerns itself with the management of cancellation policies, promotions, restrictions etc. This API lets you create:

1. Add-ons: Manage add-ons.
2. Cancellation policies: Manage cancellation policies for your property.
3. Rate plan: Manage property rate plans.
4. Master rates: Manage perks for room type / rate plan combos.
5. Promotions: Manage promotions.
6. Promotion bundle: Manage bundled promotions.

Browse the endpoints in the left navigation bar to get started.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 30.18.0
• Package version: 0.0.37
• Generator version: 7.12.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.8+

Installation & Usage

pip install

You can install the package from PyPi using:

pip install wink_sdk_extranet_monetize

Or you can install it directly from the repository using:

pip install git+https://github.com/wink-travel/wink-sdk-python.git@v0.0.37#egg=wink_sdk_extranet_monetize&subdirectory=wink-sdk-extranet-monetize

(you may need to run pip with root permission: sudo pip install git+https://github.com/wink-travel/wink-sdk-python.git@v0.0.37#egg=wink_sdk_extranet_monetize&subdirectory=wink_sdk_extranet_monetize)

Then import the package:

import wink_sdk_extranet_monetize

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import wink_sdk_extranet_monetize

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import wink_sdk_extranet_monetize
from wink_sdk_extranet_monetize.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wink.travel
# See configuration.py for a list of all supported configuration parameters.
configuration = wink_sdk_extranet_monetize.Configuration(
    host = "https://api.wink.travel"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]


# Enter a context with an instance of the API client
with wink_sdk_extranet_monetize.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wink_sdk_extranet_monetize.AddOnApi(api_client)
    property_identifier = 'hotel-1' # str | Add multimedia record to add-on record owned by this property identifier
    add_on_identifier = 'add-on-1' # str | Add multimedia record to add-on with this identifier
    simple_multimedia = wink_sdk_extranet_monetize.SimpleMultimedia() # SimpleMultimedia | 
    wink_version = 'wink_version_example' # str |  (optional)

    try:
        # Add Multimedia
        api_response = api_instance.add_multimedia(property_identifier, add_on_identifier, simple_multimedia, wink_version=wink_version)
        print("The response of AddOnApi->add_multimedia:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AddOnApi->add_multimedia: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.wink.travel

Class	Method	HTTP request	Description
AddOnApi	add_multimedia	PATCH /api/property/{propertyIdentifier}/add-on/{addOnIdentifier}/multimedia	Add Multimedia
AddOnApi	create_add_on	POST /api/property/{propertyIdentifier}/add-on	Create Add-On
AddOnApi	remove_add_on	DELETE /api/property/{propertyIdentifier}/add-on/{addOnIdentifier}	Delete Add-On
AddOnApi	remove_multimedia	DELETE /api/property/{propertyIdentifier}/add-on/{addOnIdentifier}/multimedia/{multimediaIdentifier}	Delete Multimedia
AddOnApi	show_add_on	GET /api/property/{propertyIdentifier}/add-on/{addOnIdentifier}	Show Add-On
AddOnApi	show_add_ons	GET /api/property/{propertyIdentifier}/add-on/list	Show Add-Ons
AddOnApi	update_add_on	PUT /api/property/{propertyIdentifier}/add-on/{addOnIdentifier}	Update Add-On
AddOnApi	update_add_on_multimedia	PATCH /api/property/{propertyIdentifier}/add-on/{addOnIdentifier}/multimedia/{multimediaIdentifier}	Update Multimedia
AddOnApi	upload_binary_add_on_media	POST /api/property/{propertyIdentifier}/add-on/{addOnIdentifier}/multimedia	Upload Binary Multimedia
CancellationPolicyApi	create_cancellation_policy	POST /api/property/{propertyIdentifier}/cancellation-policy	Create Cancellation Policy
CancellationPolicyApi	is_cancellation_policy_removable	GET /api/property/{propertyIdentifier}/cancellation-policy/{cancellationPolicyIdentifier}/removable	Verify Removable
CancellationPolicyApi	remove_cancellation_policy	DELETE /api/property/{propertyIdentifier}/cancellation-policy/{cancellationPolicyIdentifier}	Delete Cancellation Policy
CancellationPolicyApi	show_cancellation_policy	GET /api/property/{propertyIdentifier}/cancellation-policy/{cancellationPolicyIdentifier}	Show Cancellation Policy
CancellationPolicyApi	show_cancellation_policy_list	GET /api/property/{propertyIdentifier}/cancellation-policy/list	Show Cancellation Policies
CancellationPolicyApi	update_cancellation_policy	PUT /api/property/{propertyIdentifier}/cancellation-policy/{cancellationPolicyIdentifier}	Update Cancellation Policy
MasterRateApi	set_perks	PATCH /api/property/{propertyIdentifier}/master-rate/{masterRateIdentifier}/perks	Set Master Rate Perks
MasterRateApi	show_master_rate	GET /api/property/{propertyIdentifier}/master-rate/{masterRateIdentifier}	Show Master Rate
MasterRateApi	show_master_rates	GET /api/property/{propertyIdentifier}/master-rate/list	Show Master Rates
MasterRateApi	toggle_master_rate	PATCH /api/property/{propertyIdentifier}/master-rate/{masterRateIdentifier}/toggle	Toggle Master Rate
PromotionApi	create_promotion	POST /api/property/{propertyIdentifier}/promotion	Create Promotion
PromotionApi	remove_rate_modifier	DELETE /api/property/{propertyIdentifier}/promotion/{rateModifierIdentifier}	Delete Promotion
PromotionApi	show_promotion	GET /api/property/{propertyIdentifier}/promotion/{rateModifierIdentifier}	Show Promotion
PromotionApi	show_promotions	GET /api/property/{propertyIdentifier}/promotion/list	Show Promotions
PromotionApi	update_promotion	PUT /api/property/{propertyIdentifier}/promotion/{rateModifierIdentifier}	Update Promotion
PromotionBundleApi	create_rate_modifier_bundle	POST /api/property/{propertyIdentifier}/promotion-bundle	Create Promotion Bundle
PromotionBundleApi	remove_rate_modifier_bundle	DELETE /api/property/{propertyIdentifier}/promotion-bundle/{rateModifierBundleIdentifier}	Delete Promotion Bundle
PromotionBundleApi	show_rate_modifier_bundle	GET /api/property/{propertyIdentifier}/promotion-bundle/{rateModifierBundleIdentifier}	Show Promotion Bundle
PromotionBundleApi	show_rate_modifier_bundles	GET /api/property/{propertyIdentifier}/promotion-bundle/list	Show Promotion Bundles
PromotionBundleApi	update_rate_modifier_bundle	PUT /api/property/{propertyIdentifier}/promotion-bundle/{rateModifierBundleIdentifier}	Update Promotion Bundle
RatePlanApi	create_rate_plan	POST /api/property/{propertyIdentifier}/rate-plan	Create Rate Plan
RatePlanApi	remove_rate_plan	DELETE /api/property/{propertyIdentifier}/rate-plan/{ratePlanIdentifier}	Delete Rate Plan
RatePlanApi	show_rate_plan	GET /api/property/{propertyIdentifier}/rate-plan/{ratePlanIdentifier}	Show Rate Plan
RatePlanApi	show_rate_plans	GET /api/property/{propertyIdentifier}/rate-plan/list	Show Rate Plans
RatePlanApi	update_rate_plan	PUT /api/property/{propertyIdentifier}/rate-plan/{ratePlanIdentifier}	Update Rate Plan

Documentation For Models

• AddOn
• Address
• AddressSupplier
• AdvanceBookingRateQualifierSupplier
• ArrivalDaysOfWeekRateQualifierSupplier
• AvailableDaysOfWeekRateQualifierSupplier
• BedSupplier
• BedroomConfigurationSupplier
• BedroomSupplier
• BlackoutDateSupplier
• CancellationPolicyException
• CancellationPolicyExceptionSupplier
• CancellationPolicyExceptions
• CancellationPolicyExceptionsSupplier
• CancellationPolicyLightweight
• CancellationPolicyLightweightSupplier
• CancellationPolicyRemovableResponseSupplier
• CancellationPolicySupplier
• CityRateQualifierSupplier
• Contact
• ContactSupplier
• ContinentRateQualifierSupplier
• CountryLightweight
• CountryLightweightSupplier
• CountryRateQualifierSupplier
• CustomMonetaryAmount
• DepartureDaysOfWeekRateQualifierSupplier
• DowPatternGroup
• DowPatternGroupSupplier
• GenericErrorMessage
• GeoIpLightweightSupplier
• GeoJsonPoint
• GeoJsonPointSupplier
• GeoNameCountrySupplier
• GeoNameLightweight
• GeoNameLightweightSupplier
• IPRangeRateQualifierSupplier
• IdentifierNamePairSupplier
• LengthOfStayRateQualifierSupplier
• LocalizedDescription
• LocalizedDescriptionSupplier
• MasterRateSupplier
• MediaAuthorAttribution
• MediaAuthorAttributionSupplier
• MinutesBeforeBookingStartDateRateQualifierSupplier
• PrepayRateQualifierSupplier
• PromotionRateQualifierSupplier
• RatePlanLevelFee
• RatePlanLevelFeeSupplier
• RatePlanLightweight
• RatePlanLightweightSupplier
• RatePlanSupplier
• RefundableRateQualifierSupplier
• RemoveEntryResponse
• RequiredDaysOfWeekRateQualifierSupplier
• RoomRangeRateQualifierSupplier
• RoomTypeLightweightSupplier
• SellDateRateQualifierSupplier
• SetMasterRatePerkRequestSupplier
• ShowRatePlan400Response
• SimpleDescription
• SimpleDescriptionSupplier
• SimpleMultimedia
• SimpleMultimediaSupplier
• Social
• SocialSupplier
• SpecialRateBundleSupplier
• SpecialRateSupplier
• StayDateRateQualifierSupplier
• SubCountryLightweight
• SubCountryLightweightSupplier
• SubSubCountryLightweight
• SubSubCountryLightweightSupplier
• TimezoneRateQualifierSupplier
• ToggleMasterRateRequestSupplier
• TransactionalTravelInventory
• TransactionalTravelInventorySupplier
• TravelInventoryRecognition
• TravelInventoryRecognitionSupplier
• UpsertAddOnRequest
• UpsertAddressRequest
• UpsertCancellationPolicyExceptionSupplier
• UpsertCancellationPolicyExceptionsSupplier
• UpsertCancellationPolicyRequestSupplier
• UpsertRateModifierRequestSupplier
• UpsertRatePlanRequestSupplier
• UpsertSimpleDescription
• UpsertSpecialRateBundleRequestSupplier
• VariableCharge
• VariableChargeSupplier

Documentation For Authorization

Authentication schemes defined for the API:

oauth2ClientCredentials

• Type: OAuth
• Flow: application
• Authorization URL: https://iam.wink.travel/oauth2/authorize
• Scopes:
• inventory.read: Read Wink data
• inventory.write: Create Wink data
• inventory.remove: Remove Wink data

Author

[e-mail]