What is the Tourwriter API?

Tourwriter provides a standard API (Application Programming Interface) which allows your Tourwriter database to automatically interact and share information with other applications.

The Tourwriter API in more detail

The Tourwriter API uses the Representational State Transfer (REST) software architecture; this means it uses simple HTTP methods such as GET and POST. The RESTful Tourwriter API will allow Tourwriter data to be extracted in JSON format, making it easy to develop new applications and also to integrate with existing business applications such as your website.

Advantages of using Tourwriter API with your website

The Tourwriter API can be used to help you showcase and sell your travel offering on your website.. The ability to be able to look through sample itineraries and book online is a significant enhancement to the overall customer experience; the Tourwriter API makes this possible.

How?

The Tourwriter API can share data between your Tourwriter application and your website. This information can be used behind the scenes as well as on the customer facing end of your website. For example, when your customers come to your website they will be able to see detailed example itineraries that were created by you in Tourwriter. You also have the option to make these itineraries available for sale on your website. This means that when a customer buys an itinerary promoted on your website, purchase data can be automatically transferred to Tourwriter for you.

Possible ways that you can use the Tourwriter API

Feature itineraries online

Display itinerary information on your website. These itineraries will already be created in Tourwriter with all the important details your customer will need to see. They will then be displayed on your website.

Pricing

Create itineraries in Tourwriter using fine pricing control of margins, currencies, and overrides, and display these prices on your website.

Allocation

Set allocation limits in Tourwriter to ensure that your inventory (packages or add-ons) are not oversold when offering ‘book or buy now’ functionality on your website.

Management

Pulling the sold itineraries from your website into Tourwriter allows you to easily request and confirm all bookings, create invoices and publish documents.

Reporting

Once itineraries are sold through your website, the sale information will be pulled into Tourwriter, allowing you to report on financials per itinerary or across multiple itineraries and time frames. Then, data can easily be exported to your accounting systems.

Example scenario

If you want to sell your pre-designed itineraries online the API functionality is the perfect addition to Tourwriter to allow you to do this. Here is an example scenario demonstrating how this would work in Tourwriter and on your website, for both you and your customers.

1. In Tourwriter, create the sample itinerary you would like to display on your website;
2. Using your website’s content management system (CMS) create a space for this itinerary and pull the itinerary from Tourwriter using the API;
3. Your customer sees this sample itinerary on your website, books and pays for it;
4. The API then takes this information and transfers it back to Tourwriter, updating all required fields and deducting this sale from the allocation you have set (if you choose to use this feature).

Important Information to Note

In order to use the Tourwriter API, your website will have to be updated with specific code. This may require in depth customisation to your website depending on the specifics of your website content management system (CMS).

Tourwriter can provide custom work to change the available data queries, the shape of the data, and the field names. Please discuss this with your Sales Executive, or contact support@tourwriter.com for a quote.

It is possible to customise the API in order to connect the Tourwriter application with other 3rd party apps such as CRM software, an accounting system or an e-commerce portal. This can also be discussed with a Tourwriter Sales Executive.

How to set up the Tourwriter API

1. Contact your Tourwriter Sales Executive to ask about the Tourwriter API. They will give you more specific information about how the API might work specifically for your business needs.
2. Depending on the specifics of your business and the scope of what your want the API to achieve for you, your Sales Executive may refer you to the Tourwriter Support Team to discuss the technical specifications, before moving forward with the sales process.
3. Once a scope has been agreed, your Sales Executive will provide you with a quote.
4. Once you complete your Tourwriter Implementation, the Tourwriter Support Team will work with you or your website developer to get your Tourwriter API up and running in line with the scope of work established during the sales process.

The post Tourwriter – API Set-up appeared first on Tourwriter Knowledge Base.

If you’re using Tourwriter to store your Contacts you can now use the MailChimp API to map your Tourwriter contacts to MailChimp.

The Tourwriter MailChimp integration is available as part of our Professional and Enterprise plans, but is also available to our Lite customers to trial until 31 December 2017. From 1 January 2018, Lite customers can contact our Support team or their Customer Success Executive to upgrade their Tourwriter Plan and continue to enjoy the push to MailChimp functionality.

Prerequisites

• You’re an existing MailChimp user. If not, you can sign up for a free account at https://mailchimp.com/
• You’ve got Contacts created in Tourwriter, and they’re categorized using Contact categories (see Tools > Setup > General lists > Contact categories)
• Your Contacts include an email address

Ready to go? Read on to learn the setup steps in MailChimp, and how to export your Contact categories from Tourwriter to MailChimp.

API key creation in MailChimp

The purpose of creating an API key is so that Tourwriter can ‘talk to’ your MailChimp account and bring your selected Contacts across ready to send emails from MailChimp. Follow the steps below in your MailChimp account to generate an API key.

1. In MailChimp, navigate to your Username at the top of the navigation bar and click the down arrow, then select Account
   
2. On the next screen, select Extras > API keys:
3. On the API creation screen, scroll to the Your API keys section
4. Select Create A Key
5. Your API key will be generated, and available from the API key field shown below
   
6. This key is required for the Tourwriter integration. Copy this key, ready to paste into Tourwriter.

List Creation in MailChimp

The final step for integration MailChimp with Tourwriter is to create a list in MailChimp, for example your “Tourwriter Contact List”. This list will act as the parent for any groups that you’ll import to MailChimp from Tourwriter.

1. In MailChimp, on the main menu (top left) click Lists
   
2. Click Create List
3. Fill in the details required such as List name, Default “from” email and Default “from” name
4. Once you click Save, the List will be created.
   
5. Next, create a Group.
6. Go to Manage contacts > Groups
7. Click Create Groups
8. You’ll need to enter a Group category and at least one Group name in order to complete this setup step. In the below example, the Group category is Agents.
9. Next, locate the ListID. This will be used in the Tourwriter application for integration.
10. Click Settings > List name and defaults
    
11. On the List name and campaign defaults screen, there will be a List ID in the area highlighted below. Copy this ID number, ready to paste into Tourwriter.

Back in Tourwriter

1. Go to Tools > Contacts > Send email to > Export to MailChimp
2. On the Tourwriter Export to MailChimp screen, paste your MailChimp API Key and List ID into the fields provided
3. Tick the Categories you would like to export from Tourwriter to MailChimp
4. Click Export

Your contacts will be exported from Tourwriter into MailChimp. Once the Export to MailChimp window has closed in Tourwriter, you will be able to locate your new List in MailChimp.

The post MailChimp Integration Guide appeared first on Tourwriter Knowledge Base.