Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@

Welcome to the __Mews Open API__ developer documentation. Here you will find all the information you need to get started working with the __Mews Open API__ as quickly as possible, as well as support in case you get stuck, and of course a full reference for each individual API. Let's jump in!

> ### Partner ID
> You will be given a Partner ID at the start of your integration journey (e.g. INT123456), please keep this safe as you will need this when it's time to certify your integration.
> Not got one yet? [Register to join the Marketplace](https://www.mews.com/en/mews-marketplace-form).
> ### Your journey with Mews
> You’re welcome to explore the Mews Open API at your own pace. To proceed with an integration, access customer environments, and join the [Mews Marketplace](mews-marketplace/README.md), see [Your journey with Mews](your-journey/README.md).

## Our APIs

Expand Down
116 changes: 82 additions & 34 deletions your-journey/README.md
Original file line number Diff line number Diff line change
@@ -1,65 +1,113 @@
# Your journey with Mews

> ### Partner ID
> You will be given a Partner ID at the start of the process (e.g. INT123456), please keep this safe as you will need this ID when it is time to certify your integration. Not got one yet? [Register to join the Marketplace](https://www.mews.com/en/partners/new-partnerships).

We want your experience working with Mews to be quick and simple, so we make the process as automated and self-service as possible and minimise touchpoints with the Mews team. You just need to follow these steps:
We aim to make your integration journey with Mews efficient and self-service, minimizing dependencies on our support team. Just follow these five steps:

* [Step 1: Explore the APIs](#step-1-exploration)
* [Step 2: Let us know what you plan to do](#step-2-qualification)
* [Step 3: Develop and test your solution](#step-3-development)
* [Step 2: Let us know what you plan to do](#step-2-registration)
* [Step 3: Develop and test your integration](#step-3-development)
* [Step 4: Get certified](#step-4-certification)
* [Step 5: Go live with a pilot](#step-5-pilot)
* [Step 6: Join the Marketplace!](#step-6-publication)
* [Step 5: Go live with your solution](#step-5-go-live)

If you have questions about the process, drop us a line to [[email protected]](mailto:[email protected]).
If you have questions about the process, reach out to [[email protected]](mailto:[email protected]).

> ### Booking Engine integrations
> Booking Engine API integrations are the exception as they do not need to be certified, do not need a pilot property, and will not normally be listed on the Marketplace. See [Booking Engine integrations](booking-engine-integrations.md).
> Booking Engine integrations are an exception: they do not need to be certified, do not need a pilot property, and will not normally be listed in the Mews Marketplace. See [Booking Engine integrations](booking-engine-integrations.md).

## Step 1: Exploration

First find out [which of our APIs you should be using](../the-mews-apis/README.md). If you're not sure, take a look at the [use cases](../use-cases/README.md) for suggestions. Each API has its own body of documentation, so you'll want to familiarize yourself with the guidelines and operations for the API you'll be using.
> Check out our public documentation.

All Mews API documentation is publicly accessible, allowing you to explore without barriers. Start by identifying [which API to use](../the-mews-apis/README.md). If you're unsure, take a look at our [use cases](../use-cases/README.md) for guidance. Each API has its own documentation—review the operations and guidelines relevant to your integration.

## Step 2: Registration

> Register your application integration with Mews (all except Booking Engine integrations).

### Partner registration
Before you begin development, register to [Become a Mews Partner](https://www.mews.com/en/partners/new-partnerships). This step is required for both public and private integrations (except Booking Engine integrations). Once approved:

* You may be invited to the [Partner Portal](https://partnerportal.mews.com), where you can manage your integrations and access support resources.
* If not, you will receive a `Partner ID` for email-based communication.

## Step 2: Qualification
### Application registration
After your partner registration is complete, register your specific application.

Once you've had a chance to familiarize yourself with the APIs and the process, you will be asked to complete a short Qualification step to answer some basic questions:
**If you have access to the Partner Portal**:

* Which API or APIs will you be developing against?
* Is this a private integration (for just one enterprise customer) or a public integration (available through the Mews Marketplace)?
* If this is a public integration, then what will be the pilot property?
* What is your estimated timescale for development?
* Log in to the [Partner Portal](https://partnerportal.mews.com).
* Navigate to __Integrations__ and select __Start New Application__.

**If you received a Partner ID instead**:

You will be prompted by email to provide basic details:
* Which API(s) will your integration use?
* Is this a private integration (for a specific enterprise) or a public integration (listed in the Mews Marketplace)?
* If public, what is the pilot property?
* What is your estimated timeline for development?

## Step 3: Development

When you've decided which API operations to use and how, you'll see each API has its own demo credentials for you to try them out, connecting to our demo servers. All of the information you need to start developing and testing is in the documentation. For example, if you're working with the Mews Connector API, the [guidelines](https://mews-systems.gitbook.io/connector-api/guidelines) include details of the [URLs and access credentials](https://mews-systems.gitbook.io/connector-api/guidelines/environments).
> Go develop your integration!

Once registered, you can begin development and testing in our sandbox environments. In most cases, public Demo credentials are provided in the documentation. In some cases, such as the Channel Manager API, you’ll need to request a `Client Token` from Mews to access the Demo environment. See the specific API documentation for details:

* [Mews Connector API: Demo environment access](https://mews-systems.gitbook.io/connector-api/guidelines/environments)
* [Mews Channel Manager API: Demo environment access](https://mews-systems.gitbook.io/channel-manager-api/your-journey)

## Step 4: Certification

When you are finished developing and testing, it's time to get certified! Complete the [certification form](https://mews.typeform.com/to/ehTUz7) and we'll send you further instructions by email. As part of the certification process, you will be asked for some details about your integration, such as the endpoints you will be using and the request message frequency. You can find more information about certification in the following resources:
> Let's check your integration is fit for production.

Before you can connect to live properties, public integrations must go through a Certification process to ensure compatibility and performance. The process differs depending on your access method.

**If using the Partner Portal**:

* Log in to the [Partner Portal](https://partnerportal.mews.com).
* Navigate to __Integrations__ and select __Certify Existing Applications__.

**If using a Partner ID**:

* Complete the [Certification Form](https://mews.typeform.com/to/ehTUz7).
* Instructions will follow via email.

You’ll be asked for details such as:
* Endpoints you will call
* Estimated message volume
* Retry or error handling strategy

You can find more information about certification in the documentation for individual APIs:
* [Mews Connector API Certification](https://mews-systems.gitbook.io/connector-api/guidelines/certification)
* [Mews Channel Manager API Certification](https://mews-systems.gitbook.io/channel-manager-api/certification)

> If your integration does not meet the certification criteria, we will provide feedback and ask you to address specific issues before reapplying.

## Step 5: Go live

> Let's roll out your solution to live customer sites.

### Pilot (monitoring)

We start by enabling the integration on a single property to monitor stability and performance — even for private integrations.

After a successful Certification step, you will receive a `Client Token` for connection to production sites; this token is unique to your application. To connect to a specific customer property, you will also need a second token, dependent on the API:

* __Connector API integrations__<br>
* API Documentation: [Certification](https://mews-systems.gitbook.io/connector-api/guidelines/certification)
* Mews Help: [Connector API Certification: What to expect](https://help.mews.com/s/article/connector-api-certification-what-to-expect?language=en_US)
* `Access Token` (for the Mews Connector API) – property-specific
* `Connection Token` (for the Mews Channel Manager API) – property-specific

* __Channel Manager API integrations__<br>
* API Documentation: [Certification](https://mews-systems.gitbook.io/channel-manager-api/certification)
* Mews Help: [Channel API Certification: What to expect](https://help.mews.com/s/article/channel-api-certification-what-to-expect?language=en_US)
> **Security reminder:** Tokens grant access to sensitive customer data. Treat them like passwords: store them securely, never share them, and never send them via email.

## Step 5: Pilot
**Public integration**:

After successful certification, you will be sent a `Client Token` for connection to production sites - this token is unique to your application. To connect to a customer property, you will also need an `Access Token` (for the Connector API) or `Connection Token` (for the Channel Manager API) - this token is unique to the property.
If your integration is intended to be listed publicly in the Mews Marketplace, Mews will add the integration to the agreed pilot property and you will be automatically sent the relevant token for that property (either `Access Token` for a Connector API integration, or `Connection Token` for a Channel Manager API integration). The integration will need to run successfully for a period of time(\*1) on the pilot site before you can progress to full [Publication](#publication).

> **Important:** Tokens are your security keys to access customer data in Mews, please store them safely and securely, do not share them and do not put them into email communication.
**Private integration**:

* __Public integration__<br>
If your integration is intended to be listed publicly in the Mews Marketplace, Mews will add the integration to the agreed pilot property and you will be automatically sent the relevant token for that property (either `Access Token` for a Connector API integration, or `Connection Token` for a Channel Manager API integration). The integration will need to run successfully for a period of time(\*1) on the pilot site before you can progress to [Step 6: Publication](#step-6-publication).
If this is a private integration to a single enterprise or chain, Mews will add the integration to the relevant properties and you will automatically be sent the relevant token or tokens (`Access Tokens` for Connector API integrations, or `Connection Tokens` for Channel Manager API integrations). Although there is no pilot site, we will still monitor the performance of the integration for a period of time\(*1\) just to confirm everything is ok.

* __Private integration__<br>
If this is a private integration to a single enterprise, Mews will add the integration to the relevant properties and you will automatically be sent the relevant token or tokens (`Access Tokens` for Connector API integrations, or `Connection Tokens` for Channel Manager API integrations). Although there is no pilot site, we will still monitor the performance of the integration for a period of time\(*1\) just to confirm everything is ok.
### Publication

## Step 6: Publication
After a successful pilot or monitoring stage, your integration will be declared fit for general publication. Unless it's a private integration, you will automatically be notified by email with final instructions, and your application will be listed in the [Mews Marketplace](../mews-marketplace/README.md) and on the [Mews website](https://www.mews.com/en/products/marketplace), and you can roll it out to all properties that want to integrate.

If your integration is intended to be listed publicly in the Mews Marketplace, then after an agreed period(\*1) of successful operation at the pilot site, you will automatically be notified by email with final instructions. Your solution will be listed in the Mews Marketplace and on the [Mews website](https://www.mews.com/en/products/marketplace), and you can roll it out to all properties that want to integrate. For further information, see the [Connector API onboarding guide](https://help.mews.com/s/article/connector-api-integrations-onboarding-mutual-customers?language=en_US) and the [Channel Manager API onboarding guide](https://help.mews.com/s/article/channel-manager-onboarding-guide?language=en_US).
For additional resources, search the [Mews Help Center](https://help.mews.com).

> \*1 The monitoring period will depend on circumstances, but typically this will be 2 weeks for a Connector API integration or 4 weeks for a Channel Manager API integration.
57 changes: 38 additions & 19 deletions your-journey/booking-engine-integrations.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,63 @@
# Booking Engine integrations

The steps for a Booking Engine API integration are as follows:
The integration process for the Booking Engine API is streamlined compared to other Mews APIs and does **not** require certification or a pilot property. Follow these steps:

* [Step 1: Explore the API](#step-1-exploration)
* [Step 2: Register your client name](#step-2-registration)
* [Step 3: Develop & test your solution](#step-3-development)
* [Step 4: Go live in Production](#step-4-production)
* [Step 3: Develop and test your integration](#step-3-development)
* [Step 4: Go live in Production](#step-4-go-live)

If you have questions about the process, drop us a line to [[email protected]](mailto:[email protected]).
If you have questions about the process, contact us at [[email protected]](mailto:[email protected]).

> **Client name**: Unlike other Mews APIs, the Booking Engine API uses a `client name` instead of a `Client Token` for authentication.

## Step 1: Exploration

Explore the [Booking Engine Guide](https://mews-systems.gitbook.io/booking-engine-guide/) and familiarize yourself with the API guidelines and operations.
Not sure if the API is the right option? See [Booking Engine Guide ways to integrate](https://mews-systems.gitbook.io/booking-engine-guide/faq/ways-to-integrate).
Explore the [Booking Engine Guide](https://mews-systems.gitbook.io/booking-engine-guide/) and familiarize yourself with the API guidelines and operations. Not sure if the API is the right option? See [Booking Engine Guide ways to integrate](https://mews-systems.gitbook.io/booking-engine-guide/faq/ways-to-integrate).

> Please note that connection to the Booking Engine API is only available to Mews customers with Enterprise packages.
> **Availability note**: Access to the Booking Engine API is only available to Mews customers on Enterprise packages.

## Step 2: Registration

Once you're sure you want to develop against the API, please register your client name and other details with Mews, as described in [Booking Engine API authorization](https://mews-systems.gitbook.io/booking-engine-guide/booking-engine-api/guidelines/authorization).
To do so, send an email to [[email protected]](mailto:[email protected]) like the following example.
In the meantime, you can start working with the API straight away using the sample client name, as described in [Booking Engine API authorization](https://mews-systems.gitbook.io/booking-engine-guide/booking-engine-api/guidelines/authorization).
Before you can use the API in a live environment, you need to register your `client name` and other details with Mews, including a contact email for your development department. The email address will be used to notify you about important changes in the API.

### Recommended: Use the Mews Digital Assistant

You can register directly from within the Mews platform using the **Mews Digital Assistant** (available to logged-in users). Follow the chatbot flow to open a ticket and use the following template:

> _Subject: **Booking Engine API client name registration**_
>
> * _**Client name:** `<insert your client name>`_
> * _**Contact email:** `<insert your contact email>`_
> * _**Environments:** `<Demo and/or Production>`_

### Alternatively: Register by email

If you do not have access to the Mews Digital Assistant, you can email [[email protected]](mailto:[email protected]) using the following template:

> ### Registration email
> _Subject: **Booking Engine API client name registration**_
>
> _Dear Mews support,_
>
> _We would like to register the following client for Booking Engine access:_
>
> * _Client name:_ \<insert your client name here\>
> * _Contact email:_ \<insert your contact email address here\>
> * _Environments:_ \<insert Demo and\/or Production here\>
> * _**Client name:** `<insert your client name>`_
> * _**Contact email:** `<insert your contact email>`_
> * _**Environments:** `<Demo and/or Production>`_
>
> _Best regards,_
>
> _`<Your team/company name>`_

While your `client name` is being registered, you can begin testing using the [sample client name](https://mews-systems.gitbook.io/booking-engine-guide/booking-engine-api/guidelines/authorization) provided in the documentation.

## Step 3: Development

You can connect to our Demo environment to try out API operations, using your registered client name. Until your client name is registered, you can use the sample client name.
All of the information you need to start developing and testing is in the [Booking Engine Guide](https://mews-systems.gitbook.io/booking-engine-guide/).
Use the Demo environment to start building and testing your integration. Until your own `client name` is registered, you can use the sample `client name`. All of the information you need to start developing and testing is in the [Booking Engine Guide](https://mews-systems.gitbook.io/booking-engine-guide/).

## Step 4: Go live

## Step 4: Production
Once your integration is tested and ready, you can switch to the Production environment. Booking Engine integrations do not need to be certified or piloted. You are good to go once your `client name` is active in the Production environment.

Finally, when your development & testing is complete, you can switch over to the Production environment and you're all done, no certification needed!
Note we support separate client name lists for the two environments, so make sure you are registered for the Production environment.
> **Environment registration**:
> Mews maintains separate `client name` lists for Demo and Production environments. Ensure you are explicitly registered for each environment you plan to use.