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-inventory

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.

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

Inventory API

The Inventory API exposes endpoints to retrieve inventory you already know. This API lets you:

  1. Consume shareable links.
  2. Consume property.
  3. Load up all types of inventories that were created by you such as grids, lists, maps, and individual items.

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.21.0
  • Package version: 0.0.43
  • Generator version: 7.15.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

You can install the package from PyPi using:

pip install wink_sdk_inventory

Or you can install it directly from the repository using:

pip install git+https://github.com/wink-travel/wink-sdk-python.git@v0.0.43#egg=wink_sdk_inventory&subdirectory=wink-sdk-inventory

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

Then import the package:

import wink_sdk_inventory

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_inventory

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import wink_sdk_inventory
from wink_sdk_inventory.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_inventory.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_inventory.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wink_sdk_inventory.InventoryApi(api_client)
    inventory_unavailable_notification_non_authenticated_entity = wink_sdk_inventory.InventoryUnavailableNotificationNonAuthenticatedEntity() # InventoryUnavailableNotificationNonAuthenticatedEntity | 
    wink_version = 'wink_version_example' # str |  (optional)

    try:
        # No Inventory
        api_response = api_instance.notify_property(inventory_unavailable_notification_non_authenticated_entity, wink_version=wink_version)
        print("The response of InventoryApi->notify_property:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling InventoryApi->notify_property: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
InventoryApi notify_property POST /api/inventory/unavailable No Inventory
InventoryApi show_consumable_url POST /api/shareable-link/{code} Show Shareable Link
InventoryApi show_inventory_grid_item POST /api/inventory/grid/item Show Inventory Grid Item
InventoryApi show_property_aggregate POST /api/inventory/property Show Property Inventory
InventoryApi show_property_attraction POST /api/experience/attraction Show Attraction Inventory
InventoryApi show_property_inventory POST /api/inventory Show Property
InventoryApi show_property_list POST /api/inventory/list Show Property List
InventoryApi show_property_meeting_room POST /api/facility/meeting-room Show Meeting Room Inventory
InventoryApi show_property_place POST /api/experience/place Show Place Inventory
InventoryApi show_property_rate_period POST /api/inventory/period Show Property Rate Period
InventoryApi show_property_recreation POST /api/experience/activity Show Activity Inventory
InventoryApi show_property_restaurant POST /api/facility/restaurant Show Restaurant Inventory
InventoryApi show_property_room_type POST /api/facility/room-type Show Guest Room Inventory
InventoryApi show_property_spa POST /api/facility/spa Show Spa Inventory
InventoryApi show_seller_inventory_list POST /api/inventory/grid Show Inventory Grid
InventoryApi show_seller_inventory_ranked_list POST /api/inventory/ranked/grid Show Ranked Inventories

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

This version

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

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_inventory-0.0.43.tar.gz (573.6 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_inventory-0.0.43-py3-none-any.whl (852.2 kB view details)

Uploaded Python 3

File details

Details for the file wink_sdk_inventory-0.0.43.tar.gz.

File metadata

  • Download URL: wink_sdk_inventory-0.0.43.tar.gz
  • Upload date:
  • Size: 573.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for wink_sdk_inventory-0.0.43.tar.gz
Algorithm Hash digest
SHA256 6666341162c5916b55d8b8c695c3d326fd16ae25402e5f48e52af5867f3d5b52
MD5 f726e7a975ca01f8c9a0ceb5cd669d42
BLAKE2b-256 1816d4bb051b82add5e22c39b21d8471f83a4555cffb900e28c9ccfad2fff696

See more details on using hashes here.

File details

Details for the file wink_sdk_inventory-0.0.43-py3-none-any.whl.

File metadata

File hashes

Hashes for wink_sdk_inventory-0.0.43-py3-none-any.whl
Algorithm Hash digest
SHA256 83298d8dcc458fdc7fbf38c0de939dd926c42176715c7ad5be5073503d1d981a
MD5 53b9146635f76fc7fbc39e204e4d15d8
BLAKE2b-256 941aea7992d10161d77b5cbd115e491334087577c42570aac1782ceac8d77cc6

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