Merge pull request #203 from MewsSystems/certification-update

Improvements to Your integration journey

Author: MikeAdamsMews

changelog/README.md

@@ -1,6 +1,11 @@
 # Changelog
 
+## 27th March 2025
+
+* Improvements to [Your integration journey](../your-journey/README.md) and [Certification](../your-journey/certification.md) pages. Documentation-only, no changes to API.
+
 ## 17th March 2025
+
 * [Mews: Process group](../mews-operations/reservations.md#process-group):
   * Extended request object with new `booker` property.
 

your-journey/README.md

@@ -1,42 +1,45 @@
 # Your integration journey
 
-For a general overview and step-by-step guide to the integration process for all **Mews Open API** integrations, see [Your journey with Mews](https://mews-systems.gitbook.io/open-api/your-journey). The content below focuses specifically on developing a **Mews Channel Manager API** integration.
+For a general overview and step-by-step guide to the integration process for all **Mews Open API** integrations, see [Your journey with Mews](https://mews-systems.gitbook.io/open-api/your-journey). This page focuses specifically on developing an integration with the **Mews Channel Manager API**.
 
 ## Setting up the integration
 
-Follow these steps:
+To get started, follow these steps:
 
-1. Obtain your **Client Token** from Mews, this will identify you as a Mews client in requests to the Mews side API. The token is the same for all connected properties, but different for each environment (e.g. Test or Production).
+1. **Obtain your Client Token**: Request your Client Token from Mews. This token identifies you as a Mews client when making requests to the Mews Channel Manager API. Note: The Client Token is consistent across all connected properties, but differs between environments (e.g. Test and Production).
 
-2. Set up Channel Manager side endpoints to use the same **Client Token**, this will identify Mews as a client of your system in requests to the Channel Manager side API. The token can be the same as on the Mews side, or different, but using the same token is recommended for simplicity.
+2. **Set up Channel Manager side endpoints**: Set up your channel manager side API endpoints to accept requests from Mews, using the same Client Token provided for Mews-side authentication. While you can use a different token, we recommend using the same one for simplicity.
 
-3. Provide Mews with the **endpoint URLs** for supported Channel Manager API operations.
-
-> **Channel Manager side API endpoints**: When implementing the Channel Manager side API, you can provide the endpoint URLs to Mews one by one. Production versions of the URLs can be provided after certification is completed, if desired.
+3. **Share endpoint URLs with Mews**: Provide Mews with the endpoint URLs for supported Channel Manager API operations. Tip: You can submit these URLs gradually, especially during development. Production URLs can be shared after certification if preferred.
 
 ## Connecting a property
 
-Follow these steps:
-
-1. When a property on the Mews system wishes to be connected with a channel manager using the **Mews Channel Manager API**, the connection should first be created in Mews, either by the property themselves or by Mews Support.
-   * When a connection is created in Mews, all Spaces and Rates get assigned default mapping codes automatically. If the channel manager requires its own mapping codes, they need to be passed as part of this step as the Mews default mapping codes can easily be altered by the property or by Mews Support.
+To connect a property, follow these steps:
 
-2. Obtain the **Connection Token**, which is generated by the Mews system:
-   * You can fetch all connections via the [Get properties](../mews-operations/configuration.md#get-properties) API operation and from that list you will know which connection is new to you.
-   * You can ask the property or Mews Support for the `connectionToken` when setting up the connection on your side.
+1. **Create the connection in Mews**: A connection must first be established in Mews Operations. This can be done either by the property or by Mews Support.
+    * When created, all spaces and rates are assigned default mapping codes automatically.
+    * If your system requires specific mapping codes, provide them during this step, as Mews default codes can be modified by the property or Mews Support.
+   
+2. **Obtain the Connection Token**: The Connection Token identifies the specific link between the property and your system. You can get it in two ways:
+    * Use the [Get properties](../mews-operations/configuration.md#get-properties) API operation to retrieve all connections and identify new ones.
+    * Request the token directly from the property or Mews Support.
 
-3. Obtain the connection configuration:
-   * You can fetch the configuration of a connection via API operation [Get configuration](../mews-operations/configuration.md#get-configuration).
-   * You can ask the property or Mews Support for the configuration details.
+3. **Retreive the connection configuration**: Fetch the connection’s configuration to complete the setup:
+    * Use the [Get configuration](../mews-operations/configuration.md#get-configuration) API operation.
+    * Alternatively, request the configuration details from the property or Mews Support.
 
-4. Configure the connection on the channel manager system.
+4. **Configure the connection**: Configure the connection on your channel manager system to finalize the integration.
 
-> **Test environment configurations**: In the case of the [Test environment](../guidelines/environments.md), Mews integration specialists will take care of these requests.
+> **Test environment support**: For integrations in the [Test environment](../guidelines/environments.md), Mews integration specialists will handle connection requests.
 
 ## Getting certified
 
-Once you have finished building and testing your integration, you need to get your integration certified by Mews, so it can be moved to the Production environment. Complete the [certification form](https://mews.typeform.com/to/ehTUz7) to kick off the certification process.
-The following pages explain the process in more detail. You can find additional information in the [Mews Help Center](https://help.mews.com), e.g. [Channel API Certification: What to expect](https://help.mews.com/s/article/channel-api-certification-what-to-expect?language=en_US).
+Before moving your integration to the Production environment, you’ll need to complete the Mews certification process:
+
+* Submit the [certification form](https://mews.typeform.com/to/ehTUz7) to begin.
+* Learn more:
+  * [Certification](certification.md)
+  * [Certification tests](certification-tests.md)
+  * [Channel API Certification: What to expect](https://help.mews.com/s/article/channel-api-certification-what-to-expect?language=en_US)
 
-* [Certification](certification.md)
-* [Certification tests](certification-tests.md)
+For additional support, visit the [Mews Help Center](https://help.mews.com).

your-journey/certification.md

@@ -1,52 +1,61 @@
 # Certification
 
-Once you have finished development against the API, Mews needs to confirm that the integration has been developed according to specification before it can be moved to the Production environment. This is the purpose of the certification process. During the process, a series of standard tests will be performed to check that everything is in order.
+Before moving your integration to the Production environment, Mews must verify that it meets all technical specifications. This is the purpose of the certification process. During certification, Mews will conduct a series of standard tests to ensure your integration functions correctly.
 
 ## Preparing for certification
 
 Follow these steps to prepare for certification:
 
-1. Email [email protected] to request a `Client Token` and for a test property to be created in the Mews [Test environment](../guidelines/environments.md).
-2. Create the following HTTPS endpoint URLs on the Channel Manager side [Test environment](../guidelines/environments.md):
+1. **Request a test environment setup**: Email [email protected] to request a `Client Token` and for a test property to be created in the Mews [Test environment](../guidelines/environments.md).
+
+2. **Set up Channel Manager endpoints**: Create the following HTTPS endpoints on the Channel Manager side [Test environment](../guidelines/environments.md):
     * [Update availability](../channel-manager-operations/inventory.md#update-availability) 
     * [Update prices](../channel-manager-operations/inventory.md#update-prices)
     * [Update restrictions](../channel-manager-operations/inventory.md#update-restrictions)
     * [Confirm booking](../channel-manager-operations/reservations.md#confirm-booking) 
     * [Change notification](../channel-manager-operations/notifications.md#change-notification) \(optional\)
-3. Email the endpoint details to [email protected].
-4. Use your test property username and [Get properties](../mews-operations/configuration.md#get-properties) API operation to fetch the `connectionToken` for the [Test property](../guidelines/environments.md).
-5. Pull property information, space type mapping and rate mapping information using the [Get configuration](../mews-operations/configuration.md#get-configuration) API operation.
-6. Map all the rate plan and space category combinations in the user interface of the channel manager system using the data received from the [Get configuration](../mews-operations/configuration.md#get-configuration) request.
+    
+3. **Share endpoint details**: Send the endpoint details to [email protected].
 
-> **Multi-property enterprises**: Multi-property enterprises such as vacation rentals, apartments, villas, etc. are often set up in Mews as spaces belonging to a single Mews property, i.e. the 'property' is the Mews enterprise customer and the 'spaces' are the individual rental properties.
-> These spaces (i.e. properties) can be sent to the channel manager as multiple connections, with one `Connection Token` per space (i.e. property), or as a single connection for the entire enterprise.
+4. **Retrieve the Connection Token**: Use your test property credentials with the [Get properties](../mews-operations/configuration.md#get-properties) API operation to retrieve the `Connection Token` for the [Test property](../guidelines/environments.md).
 
-## Certification tests
+5. **Fetch configuration data**: Pull property, space type mapping and rate mapping information using the [Get configuration](../mews-operations/configuration.md#get-configuration) API operation.
 
-These tests will be conducted during a 90-minute call between the Mews Marketplace team and a representative of the channel manager.  
+6. **Map rates and spaces**: Use the data from the [Get configuration](../mews-operations/configuration.md#get-configuration) response to map all rate plan and space category combinations in your channel manager system.
 
-* See [Certification tests](certification-tests.md)
+7. **Perform ARI and reservation tests**: Conduct all ARI (Availability, Rates & Inventory) and reservation tests, according to the scenarios outlined in [Certification tests](certification-tests.md).
 
-### Evaluation
+8. **Complete the certification file**: Inform your Mews Technical Partner Success Manager once you’ve completed the tests. They will provide you with a certification file. Complete the file following the provided instructions, and return the completed file via email.
 
-If the required tests cannot be completed successfully, Mews will not allow the channel manager to advance to the Production environment. Once any issues are resolved, certification will start over.
+9. **Schedule the certification call**: After submitting the certification file, you’ll receive a link to book a 90-minute certification call with Mews. Reserve a time slot that suits you.
 
-If there are no critical issues discovered during certification, the channel manager will be advanced to the Production environment.
-  * Mews will require unique HTTPS production endpoint URLs for the Channel Manager side
-  * Mews will issue a new `Client Token` for the channel manager to use in the live environment
-  * The channel manager will issue documentation of their set-up process for approval
+> **Multi-property enterprises**: Multi-property enterprises such as vacation rentals, apartments, villas, etc. are often set up in Mews as a single property with multiple individual spaces representing the individual rental properties.
+> You can send these spaces to the Channel Manager as multiple connections, with one Connection Token per space (property), or as a single connection for the entire enterprise.
 
-## Re-certification
+## Certification tests
 
-There are two scenarios in which re-certification is required:
+Certification involves a 90-minute call between the Mews Marketplace team and a representative from the Channel Manager. The tests performed during this call will be divided into three main components:
 
-1. The pilot stage has not been completed in a reasonable time (six months).
-2. The functionality supported by the integration has changed.
+* **Inventory Push Tests**: These are the primary tests performed during the call. In some cases, the call may be extended until all tests are successfully completed.
+* **Reservation Tests**: Following the Inventory Push tests, Reservation Tests will be conducted via email.
+* **Error Tests**: After the Reservation Tests, Error Tests will be conducted to check the system’s response to failed requests and invalid data.
 
-### Incomplete pilot
+For detailed descriptions of each test, see [Certification tests](certification-tests.md).
 
-If, for any reason, it was not possible to go to pilot stage with a pilot customer, or the pilot stage could not be completed, then contact Mews for re-certification.
+## Test evaluation
+
+**If tests are not passed**:
+If the required tests cannot be completed successfully, Mews will not allow the channel manager to advance to the Production environment. Once any issues are resolved, certification will start over.
+
+**If certification is successful**:
+If there are no critical issues discovered during certification, the channel manager will be advanced to the Production environment.
+  * Mews will require unique HTTPS production endpoint URLs for the Channel Manager side.
+  * Mews will issue a new `Client Token` for the channel manager to use in the Production environment.
+  * Your team will need to provide documentation of the setup process for final approval.
+
+## Re-certification
 
-### Change in functionality
+Re-certification is required in the following scenarios:
 
-If you add new functionality to an existing integration, again we will need to re-certify the integration.
+* **Incomplete pilot**: If, for any reason, it was not possible to go to pilot stage with a pilot customer, or the pilot stage could not be completed within six months, then contact Mews for re-certification.
+* **Change in functionality**: If you add new features or make significant changes to an existing integration, re-certification is required to validate the updated functionality.