Wink API

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for wink2travel from gravatar.com wink2travel

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Apache License
  • Author: Bjorn Harvold
  • Tags OpenAPI , OpenAPI-Generator , Wink API
Report project as malware

Project description

wink-sdk-extranet-distribution

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.

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

Extranet Distribution API

The Distribution API exposes endpoints for sales channels, connecting with affiliates, managing rates and inventory calendars and more on Wink. This API lets you:

  1. Verifier: Test your availability and promotions and create test bookings to simulate the entire booking workflow.
  2. Sales Channels: Manage your sales channels.
  3. Explore Network: Find new affiliates to work with.
  4. Inventory: Manage inventory at the sales channel-level.
  5. Calendars: Manage availability calendars for all your inventory.

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_distribution

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_distribution&subdirectory=wink-sdk-extranet-distribution

(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_distribution&subdirectory=wink_sdk_extranet_distribution)

Then import the package:

import wink_sdk_extranet_distribution

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_distribution

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import wink_sdk_extranet_distribution
from wink_sdk_extranet_distribution.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_distribution.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_distribution.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wink_sdk_extranet_distribution.AffiliateApi(api_client)
    property_identifier = 'hotel-1' # str | Display affiliates to this specified property
    state_supplier = wink_sdk_extranet_distribution.StateSupplier() # StateSupplier | 
    wink_version = 'wink_version_example' # str |  (optional)

    try:
        # Show Affiliates
        api_response = api_instance.browse_affiliates(property_identifier, state_supplier, wink_version=wink_version)
        print("The response of AffiliateApi->browse_affiliates:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AffiliateApi->browse_affiliates: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
AffiliateApi browse_affiliates POST /api/property/{propertyIdentifier}/sales/affiliate/grid Show Affiliates
AffiliateApi invite_affiliate POST /api/property/{propertyIdentifier}/sales/affiliate/invite Send invite
AffiliateApi show_affiliate GET /api/property/{propertyIdentifier}/sales/affiliate/{companyIdentifier} Show Affiliate
AffiliateApi show_unique_city_list GET /api/property/{propertyIdentifier}/sales/affiliate/city/list Show Unique Affiliate Cities
AffiliateApi show_unique_country_list GET /api/property/{propertyIdentifier}/sales/affiliate/country/list Show Unique Affiliate Countries
DailyRateApi bulk_update_rate PUT /api/property/{propertyIdentifier}/master-rate/{masterRateIdentifier}/rate/bulk Update Daily Rates by Range
DailyRateApi create_test_booking POST /api/property/{propertyIdentifier}/sandbox/booking Test Rate / Availability
DailyRateApi show_all_hotel_rates POST /api/property/{propertyIdentifier}/master-rate/rates/dates Daily Rates by Hotel
DailyRateApi show_all_master_rates_rates POST /api/property/{propertyIdentifier}/master-rate/{masterRateIdentifier}/rates/dates Daily Rates by Master Rate
DailyRateApi show_channels GET /api/property/{propertyIdentifier}/sandbox/channel/list List Sales Channels
DailyRateApi show_daily_rates_page POST /api/property/{propertyIdentifier}/master-rate/{masterRateIdentifier}/rate/grid Show Daily Rate Page
DailyRateApi show_descriptive_inventory POST /api/property/{propertyIdentifier}/sandbox/room/list Test Rate / Availability
DailyRateApi update_rate_list PUT /api/property/{propertyIdentifier}/rate/update Update Daily Rates by List
InventoryApi show_channel_activities GET /api/property/{propertyIdentifier}/sales/experience/activity/list Show Activity Inventories
InventoryApi show_channel_add_ons GET /api/property/{propertyIdentifier}/sales/add-on/list Show Add-On Inventories
InventoryApi show_channel_attractions GET /api/property/{propertyIdentifier}/sales/experience/attraction/list Show Attraction Inventories
InventoryApi show_channel_meeting_rooms GET /api/property/{propertyIdentifier}/sales/meeting-room/list Show Meeting Room Inventories
InventoryApi show_channel_places GET /api/property/{propertyIdentifier}/sales/experience/place/list Show Place Inventories
InventoryApi show_channel_restaurants GET /api/property/{propertyIdentifier}/sales/facility/restaurant/list Show Restaurant Inventories
InventoryApi show_channel_spas GET /api/property/{propertyIdentifier}/sales/facility/spa/list Show Spa Inventories
InventoryApi show_inventory GET /api/property/{propertyIdentifier}/sales/inventory/{inventoryIdentifier} Show Inventory
InventoryApi show_inventory_list GET /api/property/{propertyIdentifier}/sales/inventory/list Show Inventory List
InventoryApi show_inventory_names GET /api/property/{propertyIdentifier}/sales/inventory/name/list Show Inventory Names
InventoryApi show_inventory_types GET /api/property/{propertyIdentifier}/sales/inventory/type/list Show All Inventory Types
InventoryApi show_master_rates GET /api/property/{propertyIdentifier}/sales/master-rate/list Show Master Rates Inventories
InventoryApi show_pageable_channel_inventory POST /api/property/{propertyIdentifier}/sales/inventory/grid Search Inventory
InventoryApi show_sales_channel_list_by_inventory GET /api/property/{propertyIdentifier}/sales/inventory/{inventoryTypeIdentifier}/list Show Inventory as Channels
InventoryApi toggle_inventory_availability PATCH /api/property/{propertyIdentifier}/sales/inventory/{inventoryIdentifier} Update Inventory
InventoryApi toggle_inventory_list_availability PATCH /api/property/{propertyIdentifier}/sales/inventory/list Update Inventory List
InventoryUsageApi show_activity_usage GET /api/property/{propertyIdentifier}/inventory-usage/activity/{activityIdentifier} Show Activity Usage
InventoryUsageApi show_add_on_usage GET /api/property/{propertyIdentifier}/inventory-usage/add-on/{addOnIdentifier} Show Add-On Usage
InventoryUsageApi show_attraction_usage GET /api/property/{propertyIdentifier}/inventory-usage/attraction/{attractionIdentifier} Show Attraction Usage
InventoryUsageApi show_meeting_room_usage GET /api/property/{propertyIdentifier}/inventory-usage/meeting-room/{meetingRoomIdentifier} Show Meeting Room Usage
InventoryUsageApi show_place_usage GET /api/property/{propertyIdentifier}/inventory-usage/place/{placeIdentifier} Show Place Usage
InventoryUsageApi show_rate_plan_usage GET /api/property/{propertyIdentifier}/inventory-usage/rate-plan/{ratePlanIdentifier} Show Rate Plan Usage
InventoryUsageApi show_restaurant_usage GET /api/property/{propertyIdentifier}/inventory-usage/restaurant/{restaurantIdentifier} Show Restaurant Usage
InventoryUsageApi show_room_type_usage GET /api/property/{propertyIdentifier}/inventory-usage/room-type/{roomTypeIdentifier} Show Room Type Usage
InventoryUsageApi show_spa_usage GET /api/property/{propertyIdentifier}/inventory-usage/spa/{spaIdentifier} Show Spa Usage
SalesChannelApi create_sales_channel POST /api/property/{propertyIdentifier}/sales/account Create Sales Channel
SalesChannelApi remove_sales_channel DELETE /api/property/{propertyIdentifier}/sales/account/{salesChannelIdentifier} Remove Sales Channel
SalesChannelApi show_accounts GET /api/property/{propertyIdentifier}/sales/account/list Show Sales Channels
SalesChannelApi show_sales_channel GET /api/property/{propertyIdentifier}/sales/account/{salesChannelIdentifier} Show Sales Channel
SalesChannelApi show_sales_channel_context_rate_modifier_bundle_pairs GET /api/property/{propertyIdentifier}/sales/account/rate-modifier-bundle/{rateModifierBundleIdentifier}/list Show Rate Modifier Bundle Availability
SalesChannelApi show_sales_channel_context_rate_modifier_pairs GET /api/property/{propertyIdentifier}/sales/account/rate-modifier/{rateModifierIdentifier}/list Show Rate Modifier Availability
SalesChannelApi toggle_sales_channel_promo_availability PATCH /api/property/{propertyIdentifier}/sales/account/rate-modifier/{rateModifierIdentifier}/list Update Sale Channels Rate Modifiers
SalesChannelApi toggle_sales_channel_promo_bundle_availability PATCH /api/property/{propertyIdentifier}/sales/account/rate-modifier-bundle/{rateModifierBundleIdentifier}/list Update Sale Channels Rate Modifier Bundles
SalesChannelApi update_sales_channel PATCH /api/property/{propertyIdentifier}/sales/account/{salesChannelIdentifier} Update Sales Channel
SalesChannelRequestApi create_sales_channel_request POST /api/property/{propertyIdentifier}/sales-channel/request Create Sales Channel Request
SalesChannelRequestApi remove_sales_channel_request DELETE /api/property/{propertyIdentifier}/sales-channel/request/{salesChannelRequestIdentifier} Reject Sales Channel Request
SalesChannelRequestApi show_sales_channel_requests GET /api/property/{propertyIdentifier}/sales-channel/request/list Show Sales Channel Requests
SchedulerApi create_schedule_item POST /api/property/{propertyIdentifier}/schedule/{inventoryIdentifier} Create Scheduler Item
SchedulerApi remove_schedule_item DELETE /api/property/{propertyIdentifier}/schedule/{inventoryIdentifier}/item/{identifier} Delete Scheduler Item
SchedulerApi show_schedule_items GET /api/property/{propertyIdentifier}/schedule/{inventoryIdentifier}/list Show Scheduler Items
SchedulerApi update_schedule_item PUT /api/property/{propertyIdentifier}/schedule/{inventoryIdentifier}/item/{identifier} Update Scheduler Item

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

oauth2ClientCredentials

Author

bjorn@wink.travel

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for wink2travel from gravatar.com wink2travel

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Apache License
  • Author: Bjorn Harvold
  • Tags OpenAPI , OpenAPI-Generator , Wink API

Release history Release notifications | RSS feed

0.0.58

0.0.57

0.0.56

0.0.55

0.0.54

0.0.53

0.0.52

0.0.51

0.0.50

0.0.49

0.0.48

0.0.47

0.0.46

0.0.45

0.0.44

0.0.43

0.0.42

0.0.41

0.0.40

0.0.39

0.0.38

0.0.37

0.0.36

0.0.35

0.0.34

0.0.33

0.0.32

0.0.31

0.0.30

This version

0.0.29

0.0.28

0.0.27

0.0.26

0.0.25

0.0.24

0.0.23

0.0.22

0.0.21

0.0.20

0.0.19

0.0.4

0.0.3

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wink_sdk_extranet_distribution-0.0.29.tar.gz (515.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

wink_sdk_extranet_distribution-0.0.29-py3-none-any.whl (1.2 MB view details)

Uploaded Python 3

File details

Details for the file wink_sdk_extranet_distribution-0.0.29.tar.gz.

File metadata

File hashes

Hashes for wink_sdk_extranet_distribution-0.0.29.tar.gz
Algorithm Hash digest
SHA256 9e8d1baa9755a1741cad366252ebe1e1f64a838a20fb9784fcdcd7b4e8d3b34f
MD5 3b903b3f1edb37979b697da26b7dc4c7
BLAKE2b-256 fc1a48149379b3e2773cb8de3b402197bfd43a046f3f30aa1e7064c17a68a0ff

See more details on using hashes here.

File details

Details for the file wink_sdk_extranet_distribution-0.0.29-py3-none-any.whl.

File metadata

File hashes

Hashes for wink_sdk_extranet_distribution-0.0.29-py3-none-any.whl
Algorithm Hash digest
SHA256 e4b47b6c2dddaccbf105da71a56692b7a41081e52161e9b21ccee439711aa78c
MD5 f682927bfc435ce6b167d69cea2d1c48
BLAKE2b-256 473ff51cf00df3ac6d46ddce669a3ff136e45355b909d498445b747291605244

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page