Website

Release | Create guidebook release

This article describes how to publish guidebook by connecting to another software. Software systems communicate with Application-Programming-Intefaces (API).

GUIBOs APIs are all REST services, exchanging JSON through HTTP

A) Create download permission without customization.

Prerequisite: You have created a travel plan with a unique ID. This ID is required to define the travel plan for which a release is to be created and should be known to the external system from which the download release is triggered.

Creation of the download permission can be done by calling our REST/https service. This example create downloadpermissions for two devices for the trip "234"

  • Replace CCCCCC with the customer ID, you can find this under Account Settings > General Settings > Account ID

  • Replace xxxxxx-xxxxxx-xxxxxx-xxxxxx with the API key, you can find this under Account Settings > General Settings > API Key

A release requires startdate and enddate, the period during which the guidebook can be downloaded and will be available in the App.

Optional, but recommended are arrivaldate and departuredate; these must fall within the specified startdate and enddate. Those dates enable the App to show specific content for each day during the journey. 

curl --location --request POST 'https://services.schneidergeo.com/content/release/
--header 'Content-Type: application/json' \
--header 'Authorization: xxxxxx-xxxxxx-xxxxxx-xxxxxx' \
--data-raw '
   { 
       "account": "CCCCCC",
       "downloadCode": 556677,
       "guidebookExternalId": "234",
       "startdate": "2024-11-19",
       "enddate": "2024-12-26",
       "arrivaldate":"2024-11-22",
       "departuredate": "2024-12-25"
       "lang": "en",
       "devices": 2
   }
'

B) Create download permission with customization.

Prerequisite:

You have previously created the content to be added to the itinerary in a library. In the following example, content from the libraries with the IDs "HOTELS" and "TEXTINFO" is used

In the following example, the hotel "Zur Post" with the external ID "HPO1" is added to the trip "234" for the customer with the booking number/download code "556678".

  • Replace CCCCCC with the customer ID, you can find this under Account Settings > General Settings > Account ID

  • Replace xxxxxx-xxxxxx-xxxxxx-xxxxxx with the API key, you can find this under Account Settings > General Settings > API Key

  • (Optional) Include the email address as a query parameter. As the customization operates in the background, it duplicates the entire guidebook and integrates additional assets. As a result, the API response doesn't contain details about any errors that may occur during this process. However, if you provide an email address, you'll receive notifications regarding any errors encountered.

curl --location --request POST 'https://services.schneidergeo.com/content/release?email=info%40touroperator.eu' \
--header 'Content-Type: application/json' \
--header 'Authorization: xxxxxx-xxxxxx-xxxxxx-xxxxxx' \
--data-raw '
   {
       "account": "CCCCCC",
       "downloadCode": 556678,
       "guidebookExternalId": "234",
       "startdate": "2024-11-19",
       "enddate": "2024-12-31",
       "arrivaldate":"2024-11-22",
       "departuredate": "2024-12-25"
       "lang": "en",
       "devices": 2,
       "additionalAssets": [
           {
               "type":"GEO",
               "externalId":"HPO1",
               "libraryExternalId":"HOTELS"
           },
           {
               "type":"TEXT",
               "externalId":"COUNTRY_INFO_IT",
               "libraryExternalId":"TEXTINFO"
           }
       ]
   }
'

C) Create download permission for resellers

For more information how to use GUIBO's reseller capabilities to automate the publishing of travel docs from operators to resellers, click here.

To create a download permission for a reseller per API, you need the Operator ID of the partner account. The operator ID is a three character unique identifier of each GUIBO account. Please pick the Operator ID from the partner list. You find it in the culumn OID.

Add the parameter resellerOid to you API request.

What happens then?

1) The release link for the traveller will be styled with the color from the reseller's partner account. This is configures in Account Settings > General Settings > Primary color

2) The logo of the booklet is replaced with the logo of the partner account (please note that this feature is still under development).

D) Create guidebook release via CSV without personalization

To automate the creation of one or multiple releases in GUIBO, CSV files can be sent to import@schneidergeo.com at any desired time intervals. These CSV files should include the following columns:

  1. downloadcode

  2. Unique ID of your guidebook

  3. Language

  4. “Downloadable from… Date”

  5. “Valid until… Date”

  6. Number of Devices

Follow these steps to get the automatic release creation running:

1. Create a Feature Request Ticket

This step initiates the process by signaling GUIBO about your interest in utilizing the CSV import feature for automatic release creation via your csv files. Find your Servicedesk here: https://schneidergeo.atlassian.net/servicedesk/customer/portal/1

2. Submit Your Email Address

Send us the email address from which you will be sending the CSV files in the future. This is necessary to ensure that the CSV files come from a trusted source.

3. Send a Sample CSV File

Provide a sample CSV file that includes all the above-mentioned columns. This is crucial for ensuring that your CSV format is compatible with our system.

4. Configuration of the Importer for Your Account

GUIBO will configure the importer specifically for your account, ensuring that it can correctly process your CSV files.

5. Test Import

Send your CSV file to import@schneidergeo.com for a test import. This step is crucial to verify that the importer is set up correctly for your account and that your CSV files are formatted correctly.

6. Verify Your Test Import

Check your test import in GUIBO to ensure that your booking has been correctly created. This verification step is important to catch any discrepancies early and address them before setting up regular imports.

Additional Information

Ensure that the CSV file format strictly follows the specified sorted columns requirements to avoid processing errors.

By following these steps, you can streamline the release creation process in GUIBO, making it more efficient and less prone to human error.

E) Create guidebook release via CSV with personalization

To personalize releases in GUIBO, it's essential that your content, such as hotels, is organized within a library. Each hotel (or any other asset) must be assigned a unique "external ID" by you. This ID is used to identify the hotel during the import process.

1. Create a Feature Request Ticket

Title the ticket: “Personalized Release via CSV for COMPANYNAME.”

2. CSV Preparation

For adding specific POI's into releases, you will need to add one or more columns to your CSV file, corresponding to each POI you wish to include. Each of these additional columns should contain the external IDs of the POI's you're including in the release.

3. Import the Updated CSV

Import the new CSV file into GUIBO as usual. The process for importing remains the same, but the CSV now includes additional columns for personalized content.

4. Test Your Created Release:

After importing the CSV, test the created release in your release dashboard. Use the search function and enter the downloadcode of your imported release. Click on the blue "edit" button to get access to the customized guidebook.

PreviousWhite-label AppNextRelease | Read release details

Last updated