Search
K
Links

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
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": 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 with for reseller / whitelabel release

Providing a download permission for a reseller means applying the style of different brand to the guidebook documents. GUIBO picks the colors and logo from the reseller GUIBO account to create the release page and the PDF guidebook.
A download permission for resellers can be with our without customization, the procedure from step A) and step B) apply. The only difference is that you pass an additional parameter resellerOid, which identifies the reseller's partner account in GUIBO .
Prerequisite: Your reselling partners need a GUIBO account. This accounts must be connected to your GUIBO account as partner account. There are two options:
1) The reselling company is a GUIBO customer and has a GUIBO account. Please contact our support to connect the reseller's account to your account. We will contact the reseller, ask for permission and connect the accounts. You find the partner accounts when you navigate to Account > Partner Management.
2) The reselling comany is not a GUIBO customer. In this case, you can create a partner account for them, which is managed by you. The partner account has a limited set of functionalities, but you can manage the color and logo of the brand. To create such a partner account, please navigate to Account > Partner Management and add a partner, use your own email address.
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.
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-31",
"arrivaldate":"2024-11-22",
"departuredate": "2024-12-25"
"lang": "en",
"devices": 2,
"resellerOid":"HID"
}
'
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 PDF is generated with the document template from your account, which is configured in the respective guidebook in Print > Settings > White label document template . The logo of the partner account will be used for this.