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

Extranet Booking API

The Booking API exposes endpoints to manage bookings. This API lets you:

  1. Booking: Manage bookings including cancellations.
  2. Review: Manage user reviews.
  3. Sync w. Calendar: Manage calendar sync with your favorite calendar software

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.24.0
  • Package version: 0.0.48
  • Generator version: 7.16.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_extranet_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.48#egg=wink_sdk_extranet_booking&subdirectory=wink-sdk-extranet-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.48#egg=wink_sdk_extranet_booking&subdirectory=wink_sdk_extranet_booking)

Then import the package:

import wink_sdk_extranet_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_extranet_booking

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import wink_sdk_extranet_booking
from wink_sdk_extranet_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_extranet_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_extranet_booking.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wink_sdk_extranet_booking.AnalyticsApi(api_client)
    property_identifier = 'hotel-1' # str | Show active booking count for hotel with this identifier
    booking_overview_request_supplier = wink_sdk_extranet_booking.BookingOverviewRequestSupplier() # BookingOverviewRequestSupplier | Overview request body
    wink_version = 'wink_version_example' # str |  (optional)

    try:
        # Property Booking Analytics
        api_response = api_instance.show_property_booking_analytics(property_identifier, booking_overview_request_supplier, wink_version=wink_version)
        print("The response of AnalyticsApi->show_property_booking_analytics:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AnalyticsApi->show_property_booking_analytics: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
AnalyticsApi show_property_booking_analytics POST /api/property/{propertyIdentifier}/booking/analytics Property Booking Analytics
CalendarSyncApi caldav GET /api/cal/property/{propertyIdentifier}/booking/list Load CalDAV Calendar
CalendarSyncApi generate_cal_dav_auth GET /api/property/{propertyIdentifier}/caldav/auth/regen Create CalDAV Connection
CalendarSyncApi retrieve_cal_dav_auth GET /api/property/{propertyIdentifier}/caldav/auth Show CalDAV Connection
ConsumerBookingApi respond_to_review PATCH /api/property/{propertyIdentifier}/review/{reviewIdentifier}/response Respond to Review
PropertyBookingApi cancel_hotel_booking PATCH /api/property/{propertyIdentifier}/booking/{bookingIdentifier}/cancel Cancel Booking
PropertyBookingApi generate_booking_report GET /api/property/{propertyIdentifier}/booking/{bookingIdentifier}/report/pdf Download Booking
PropertyBookingApi is_booking_cancellable GET /api/property/{propertyIdentifier}/booking/{bookingIdentifier}/cancellable Is Booking Cancellable
PropertyBookingApi request_refund PATCH /api/property/{propertyIdentifier}/booking/{bookingIdentifier}/request-refund Request refund
PropertyBookingApi resend_booking_confirmation_email PATCH /api/property/{propertyIdentifier}/booking/{bookingIdentifier}/resend Resend Booking Confirmation
PropertyBookingApi show_active_affiliates GET /api/property/{propertyIdentifier}/booking/owner/list Show Active Affiliates
PropertyBookingApi show_active_master_rates GET /api/property/{propertyIdentifier}/booking/roomrate/list Show Active Master Rates
PropertyBookingApi show_booking_overview GET /api/property/{propertyIdentifier}/booking/overview Property Booking Overview
PropertyBookingApi show_hotel_booking GET /api/property/{propertyIdentifier}/booking/{bookingIdentifier} Show Booking
PropertyBookingApi show_hotel_bookings POST /api/property/{propertyIdentifier}/booking/grid Search Bookings
PropertyBookingApi show_hotel_bookings1 GET /api/property/{propertyIdentifier}/booking/list Show Bookings
ReviewApi show_review GET /api/property/{propertyIdentifier}/review/{reviewIdentifier} Show Review
ReviewApi show_review_count GET /api/property/{propertyIdentifier}/review/count Show Review Count
ReviewApi show_reviews POST /api/property/{propertyIdentifier}/review/grid Show Reviews
TestBookingApi create_test_booking POST /api/property/{propertyIdentifier}/sandbox/booking Test Rate / Availability

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

This version

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

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_booking-0.0.48.tar.gz (459.8 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_booking-0.0.48-py3-none-any.whl (1.2 MB view details)

Uploaded Python 3

File details

Details for the file wink_sdk_extranet_booking-0.0.48.tar.gz.

File metadata

File hashes

Hashes for wink_sdk_extranet_booking-0.0.48.tar.gz
Algorithm Hash digest
SHA256 187c00f37eae9fbeb8609c225a75b759eae5494761dc3dccbedc7ae8819d8dbf
MD5 3266bc44731d31efa571ae43c030096c
BLAKE2b-256 ae8f488fd04ed7e14670142d6abe2305093e82cfbc52606e60ab6276c75fc536

See more details on using hashes here.

File details

Details for the file wink_sdk_extranet_booking-0.0.48-py3-none-any.whl.

File metadata

File hashes

Hashes for wink_sdk_extranet_booking-0.0.48-py3-none-any.whl
Algorithm Hash digest
SHA256 a52560f61982b1ad7192b2d1bc49820bf468e0ecac5794d763d5878d806025d2
MD5 2ac2589792d64fa5e34f6c4f8082d60f
BLAKE2b-256 ca79b03ea7f26f711e5f470c9ab62feb12d04c1c242f91e162ee09fddc1e08d6

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