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

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

Booking Engine API

Welcome to the Booking Engine API - A programmer-friendly way to book inventory that was found on our platform. This API lets you:

  1. Shopping Cart: Manage shopping cart.
  2. Checkout: Move shopping cart items through the reactive workflow.
  3. Booking: Move selected inventory through to booking completion.
  4. Review: Leave a review after a completed stay.

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_booking

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_booking&subdirectory=wink-sdk-booking

(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_booking&subdirectory=wink_sdk_booking)

Then import the package:

import wink_sdk_booking

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_booking

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import wink_sdk_booking
from wink_sdk_booking.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_booking.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_booking.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wink_sdk_booking.BookingApi(api_client)
    booking_identifier = 'booking-1' # str | Cancel booking by identifier
    cancellation_detail_booker = wink_sdk_booking.CancellationDetailBooker() # CancellationDetailBooker | 
    wink_version = 'wink_version_example' # str |  (optional)

    try:
        # Cancel Booking
        api_response = api_instance.cancel_booking(booking_identifier, cancellation_detail_booker, wink_version=wink_version)
        print("The response of BookingApi->cancel_booking:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling BookingApi->cancel_booking: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
BookingApi cancel_booking PATCH /api/booking/{bookingIdentifier} Cancel Booking
BookingApi cancel_group_booking PATCH /api/booking/group/{groupIdentifier} Cancel Group Booking
BookingApi resend_booking_confirmation_email PATCH /api/booking/{bookingIdentifier}/resend Resend Booking Confirmation
BookingApi show_booking GET /api/booking/{bookingIdentifier} Show Booking
BookingApi show_booking_by_transaction_id GET /api/booking/tx/{transactionIdentifier} Show Booking by TX ID
BookingApi show_booking_grid POST /api/booking/grid Search Bookings
BookingApi show_bookings GET /api/booking/list Show Booking List
BookingApi show_bookings_by_review_state GET /api/booking/review/list Show Bookings by Review
BookingApi show_bookings_by_state GET /api/booking/state Show Bookings by Time
BookingApi show_grouped_bookings GET /api/booking/group/{groupIdentifier} Show Grouped Bookings
CheckoutApi checkout POST /api/checkout Prepare reactive
ReviewApi populate_review GET /api/booking/{bookingIdentifier}/review/questions Show Review Template
ReviewApi submit_review POST /api/booking/{bookingIdentifier}/review Submit Review
ShoppingCartApi create_cart POST /api/shopping-cart Create Shopping Cart
ShoppingCartApi create_carts POST /api/shopping-cart/list Create Shopping Carts
ShoppingCartApi delete_cart DELETE /api/shopping-cart/{shoppingCartIdentifier} Remove Shopping Cart
ShoppingCartApi delete_cart_item DELETE /api/shopping-cart/{shoppingCartIdentifier}/item/{shoppingCartItemIdentifier} Remove Shopping Cart Item
ShoppingCartApi delete_cart_item_ancillary DELETE /api/shopping-cart/{shoppingCartIdentifier}/item/{shoppingCartItemIdentifier}/ancillary/{shoppingCartItemAncillaryIdentifier} Remove Shopping Cart Item Ancillary
ShoppingCartApi delete_carts DELETE /api/shopping-cart Empty Shopping Carts
ShoppingCartApi empty_cart DELETE /api/shopping-cart/{shoppingCartIdentifier}/empty Empty Shopping Cart
ShoppingCartApi show_cart GET /api/shopping-cart/{shoppingCartIdentifier} Show Shopping Cart
ShoppingCartApi show_carts GET /api/shopping-cart/list Show Shopping Carts
ShoppingCartApi update_cart_item PATCH /api/shopping-cart/{shoppingCartIdentifier}/item/{shoppingCartItemIdentifier} Update Shopping Cart 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_booking-0.0.29.tar.gz (334.1 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_booking-0.0.29-py3-none-any.whl (842.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: wink_sdk_booking-0.0.29.tar.gz
  • Upload date:
  • Size: 334.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for wink_sdk_booking-0.0.29.tar.gz
Algorithm Hash digest
SHA256 6c147ae7eb5f8656bec73dfbd7d8f48d0857266fae94a1dfecdb50ea8e761b4b
MD5 4a4a7e748f2022d83a4cca82e7f9e321
BLAKE2b-256 25e8efdb839503a6c21e11c20e42dbecff50f2667fe9c5db4bb14fb5465fb70e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for wink_sdk_booking-0.0.29-py3-none-any.whl
Algorithm Hash digest
SHA256 b29d875a11311fa3e7c8693f1556091e218c29b5412df6ecd66449ead8503949
MD5 84218753c4a10a2e3a2fb46340f78c9f
BLAKE2b-256 be5b66ebf872283c6ec6dc38101b9196ab5697b1318f42b7f5c537c1d8391cc4

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