sFTP Interface

Owned by Renata Rusecka
Last updated: Oct 12, 2023 by Björn Östberg
2 min read

To integrate your PMS with Customer Alliance sFTP interface you need to contact Customer Support team

We handle these on request and it is possible that requests gets rejected.

Instead we recommend leveraging our APIs.


This document provides general information about the process to connect your PMS to Customer Alliance Platform via an sFTP interface.

Set up process

  1. Contact our Customer Care Team in order to enable the interface support.

  2. After the interface has been set up you will receive an email with all the required credentials: host, port of the sFTP server, your user name and a link to set up the sFTP password.

  3. Now you can connect your PMS exporting the guest information in the Customer Alliance sFTP server.

After the interface has been enabled, make sure to click on the “Create password” link, this link will expire after 7 days and can be used only once. Due to GDPR reasons you will need to set up the password yourself. Keep it in a safe place and in case you forget it contact our Customer Care Team, they will send you an email with the new credentials and link to set up a new password, this action will delete your user and all files that you might have uploaded.

Requirements

Ensure on the following points when uploading your files:

  • The supported file formats are CSV, TXT and XML

  • The file needs to be encoded in one of our supported formats:

    • UTF-8

    • ISO 8859-1

    • ISO 8859-15

    • ISO 8859-16

List of guest attributes

Related to each guest you can add additional information related to the guest that can be useful in the platform, E.g the phone number to send SMS invitations.

This list of fields is orientative and depending on the specific PMS interface integration might vary

Name
Required
Description
Name
Required
Description

hotel_id

no

The guest hotel in case apply

name

yes

The last name of the guest

email

yes

Email address to which the invitation is to be sent.

first_name

no

The first name of the guest

gender

yes

Gender is required for the guest salutation

Check the supported gender abbreviations

language

yes

Language of the guest in ISO 639-1 format

Check the supported language abbreviations

arrival_date

no

Arrival date of the guest, must be provided in YYYY-MM-DD format.

The arrival date of the guest can be given optionally.

departure_date

yes

Departure date of the guest

Must be provided in YYYY-MM-DD format

At most 180 days in the past or future, no more

phone_number

no

The phone number of the guest can be given optionally. The phone number has to follow the E.164 recommendation. https://en.wikipedia.org/wiki/E.164 .
This should be a mobile phone number as could be used to send SMS.

cancelled

no

Guest cancellation status as boolean field. If a true value is given, then the guest is marked as cancelled and any further communication with the guest is stopped.

It's recommended to update the guest cancellation status at least once a day to ensure a fluid guest communication flow.

reservation_id

yes

Unique ID of the reservation/booking by the guest in a given hotel. This field is mandatory if the arrival_date given is in the future.

guest_profile_id

no

Unique ID of the guest within a given hotel. This usually corresponds to the guest profile ID within a given hotel. This field can be a string.

room_number

no

The room number where the guest stayed. This field can be a string.

room_category

no

The category of the room where the guest stayed, e.g. suite, single, double-room. This field can be a string.