wink-sdk-extranet-property 0.0.29

Wink API

wink-sdk-extranet-property

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 reactive 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 Property API

This part of the documentation concerns itself with basic property management. It can:

1. Property: List existing properties. Manage property status. Change name and similar.
2. Notification: Read internal messages sent from Wink to your properties.
3. Announcement: Show pertinent messages to travelers in a pop-up window.
4. Geo-location: Set property geo-location.
5. Green Index: Answer eco-related questions regarding the property's recycling practices and much more.
6. Lifestyles: Manage lifestyles the property caters to.
7. Photos / Videos: Manage property media.
8. Policy: Manage property policy. I.e. Children, pets, wi-fi, parking etc.
9. Reputation: Manage awards, online / offline ratings etc.
10. Services: Manage property amenities.
11. Social media: Manage property social media networks.
12. Welcome text: Manage property descriptions

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.17.5
• Package version: 0.0.29
• 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_property

Or you can install it directly from the repository using:

pip install git+https://github.com/wink-travel/wink-sdk-python.git@v0.0.29#egg=wink_sdk_extranet_property&subdirectory=wink-sdk-extranet-property

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

Then import the package:

import wink_sdk_extranet_property

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_property

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import wink_sdk_extranet_property
from wink_sdk_extranet_property.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_property.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_property.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wink_sdk_extranet_property.AnnouncementApi(api_client)
    property_identifier = 'hotel-1' # str | Create announcement for this property identifier
    upsert_announcement_request_supplier = wink_sdk_extranet_property.UpsertAnnouncementRequestSupplier() # UpsertAnnouncementRequestSupplier | 
    wink_version = 'wink_version_example' # str |  (optional)

    try:
        # Create Announcement
        api_response = api_instance.create_announcement(property_identifier, upsert_announcement_request_supplier, wink_version=wink_version)
        print("The response of AnnouncementApi->create_announcement:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AnnouncementApi->create_announcement: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AnnouncementApi	create_announcement	POST /api/property/{propertyIdentifier}/announcement	Create Announcement
AnnouncementApi	remove_announcement	DELETE /api/property/{propertyIdentifier}/announcement/{announcementIdentifier}	Delete Announcement
AnnouncementApi	show_announcement	GET /api/property/{propertyIdentifier}/announcement/{announcementIdentifier}	Show Announcement
AnnouncementApi	show_announcements	GET /api/property/{propertyIdentifier}/announcement/list	Show Announcements
AnnouncementApi	update_announcement	PUT /api/property/{propertyIdentifier}/announcement/{announcementIdentifier}	Update Announcement
ChannelManagerApi	update_channel_manager	PATCH /api/property/{propertyIdentifier}/channel-manager	Set Channel Manager
GeoLocationApi	update_geo_location	PATCH /api/property/{propertyIdentifier}/location	Set Geo-Location
LifestyleApi	show_lifestyles	GET /api/property/{propertyIdentifier}/lifestyles	Show Lifestyles
LifestyleApi	update_lifestyles	PUT /api/property/{propertyIdentifier}/lifestyles	Update Lifestyles
MediaApi	create_multimedia	POST /api/property/{propertyIdentifier}/multimedia	Create Multimedia
MediaApi	remove_media_list	DELETE /api/property/{propertyIdentifier}/multimedia/list	Delete Multimedia List
MediaApi	remove_multimedia	DELETE /api/property/{propertyIdentifier}/multimedia/{multimediaIdentifier}	Delete Multimedia
MediaApi	show_media_list	GET /api/property/{propertyIdentifier}/multimedia/list	Show Multimedia
MediaApi	update_media_list	POST /api/property/{propertyIdentifier}/multimedia/list	Update Multimedia List
MediaApi	update_multimedia	PUT /api/property/{propertyIdentifier}/multimedia/{multimediaIdentifier}	Update Multimedia
MediaApi	upload_multipart_files	POST /api/property/{propertyIdentifier}/multimedia/upload	Upload Multimedia
PolicyApi	create_policy	POST /api/property/{propertyIdentifier}/policy/property	Create property policy
PolicyApi	show_property_policy	GET /api/property/{propertyIdentifier}/policy/property	Show property policy
PolicyApi	update_property_policy	PUT /api/property/{propertyIdentifier}/policy/property	Update property policy
PropertyApi	change_property_name	PATCH /api/property/{propertyIdentifier}/change-name	Change Property Name
PropertyApi	improve_welcome_text	POST /api/property/{propertyIdentifier}/welcome-text/improve	Improve Welcome Text
PropertyApi	is_hotel_name_unique	GET /api/property/unique/name	Check Property Name Uniqueness
PropertyApi	is_hotel_url_name_unique	GET /api/property/unique/url-name	Check Property Url Slug Uniqueness
PropertyApi	property_search	POST /api/property/grid	Property Search
PropertyApi	show_hotel_by_manager	GET /api/property/{propertyIdentifier}	Show Property
PropertyApi	show_hotel_status	GET /api/property/{propertyIdentifier}/status	Show Property Status
PropertyApi	show_hotels_by_manager	GET /api/property/list	Property List
PropertyApi	suggest_property_profile	POST /api/property/{propertyIdentifier}/profile/suggest	Suggest property profile
PropertyApi	suggest_property_welcome_text	POST /api/property/{propertyIdentifier}/welcome-text/suggest	Suggest Property Welcome Text
PropertyApi	suggest_property_welcome_text1	POST /api/property/{propertyIdentifier}/services/suggest	Suggest property amenities
PropertyApi	update_address	PATCH /api/property/{propertyIdentifier}/address	Update Property Address
PropertyApi	update_general_manager	PATCH /api/property/{propertyIdentifier}/general-manager	Update General Manager
PropertyApi	update_hotel_status	PATCH /api/property/{propertyIdentifier}/status	Update Property Status
PropertyApi	update_property_profile	PATCH /api/property/{propertyIdentifier}/profile	Update Property Profile
PropertyApi	update_reservations_desk	PATCH /api/property/{propertyIdentifier}/contact-info	Update Reservations Desk
PropertyApi	update_services	PATCH /api/property/{propertyIdentifier}/services	Update Property Services
PropertyApi	update_welcome_text	PATCH /api/property/{propertyIdentifier}/welcome-text	Update Property Text
PropertyApi	upload_general_manager_profile_picture	POST /api/property/{propertyIdentifier}/multimedia/general-manager/upload	Upload General Manager Image
RecognitionApi	create_recognition	POST /api/property/{propertyIdentifier}/recognition	Create Recognition
RecognitionApi	remove_recognition	DELETE /api/property/{propertyIdentifier}/recognition/{recognitionIdentifier}	Delete Recognition
RecognitionApi	show_recognition	GET /api/property/{propertyIdentifier}/recognition/{recognitionIdentifier}	Show Recognition
RecognitionApi	show_recognitions	GET /api/property/{propertyIdentifier}/recognition/list	Show Recognitions
RecognitionApi	show_recognitions_by_category	GET /api/property/{propertyIdentifier}/recognition/{category}/list	Show Recognition by Category
RecognitionApi	update_recognition	PUT /api/property/{propertyIdentifier}/recognition/{recognitionIdentifier}	Update Recognition
SocialNetworkApi	show_social_networks	GET /api/property/{propertyIdentifier}/social-networks	Show Social Networks
SocialNetworkApi	update_socials	PATCH /api/property/{propertyIdentifier}/social-networks	Update Social Networks

Documentation For Models

• AddressSupplier
• AggregateDescriptorSupplier
• AggregateGreendexAnswersSupplier
• AggregateGreendexScoreByCategorySupplier
• AnnouncementSupplier
• ChangePropertyNameRequestSupplier
• CompositeFilterDescriptorSupplier
• ContactSupplier
• CountryLightweightSupplier
• CustomMonetaryAmount
• FilterDescriptorSupplier
• GeneralManagerSupplier
• GenericErrorMessage
• GeoJsonPointSupplier
• GeoNameLightweightSupplier
• GroupDescriptorSupplier
• ImageAttributionSupplier
• ImproveWelcomeTextRequestSupplier
• KeyValuePairSupplier
• LifestylesResponseSupplier
• LocalizedDescriptionSupplier
• PagePropertySupplier
• PageableObjectSupplier
• PropertyLightweightSupplier
• PropertyPolicySupplier
• PropertySupplier
• ShowRecognition400Response
• SimpleDescriptionSupplier
• SimpleMultimediaSupplier
• SocialNetworksRequestSupplier
• SocialNetworksResponseSupplier
• SocialSupplier
• SortDescriptorSupplier
• SortObjectSupplier
• StateSupplier
• SubCountryLightweightSupplier
• SubSubCountryLightweightSupplier
• SuggestAmenitiesRequestSupplier
• SuggestProfileRequestSupplier
• SuggestProfileResponseSupplier
• SuggestWelcomeTextRequestSupplier
• TravelInventoryRecognitionSupplier
• UniqueResultSupplier
• UpdateChannelManagerRequestSupplier
• UpdateExternalHotelStatusRequestSupplier
• UpdateLifestylesRequestSupplier
• UpdateLocationRequestSupplier
• UpdatePropertyAmenitiesAndServicesRequestSupplier
• UpsertAddressRequestSupplier
• UpsertAnnouncementRequestSupplier
• UpsertContactInfoRequestSupplier
• UpsertPropertyAddressRequestSupplier
• UpsertPropertyProfileRequestSupplier
• UpsertRecognitionSupplier
• UpsertSimpleDescriptionSupplier
• UpsertWelcomeTextRequestSupplier

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]