TFW Client-API

Introduction

Dear API professional, welcome to the documentation of our Client-API.

We provide a REST compliant interface created and owned by traum-ferienwohnungen. The API is provided as a self-service solution which is intended to maintain customer-oriented information by synchronizing it with their central management tool. This will be most likely information for customer related properties, like occupancies or descriptions.
All data which can be maintained in the customer's account at traum-ferienwohnungen, can be maintained by using the Client-API as well.
Support and usage are completely free of charge.

As mentioned earlier, the Client-API is based on REST, which means, that it contains APIs with different services. Each service can be accessed via different HTTP methods like GET or POST.


So let's get you started!

In order to start using the API, please call your account manager or customer support - they will register a Client-API user account for you as described under the Landingpage. If you are acting on behalf of one of our customers and don't know who to call - try +49 421 146 29 700 and ask our support team, they will be happy to help.
Once you activated your account via the email we sent you, you will be able to add customers to your user account. You will need their account ID - please see the documentation for this process in the Account API which also allows to manage your account details. Your customer will need to activate their account via email before you can modify their listing data.
If you are starting from scratch and like to test what you are writing, feel free to create a customer account on our website to test your code.

And here are the basics:

In order to use the Client-API, you will need to send your information to the URL of the service, which contains the information you want to change and the method according to the change.

All requests will require two headers┬╣:

NAME VALUE
Authorization Basic QWxhZGRpbjpPcGVuU2VzYW1l┬▓
Content-Type application/json

1. With the exception of registration which only needs the Content-Type

2. You will need to replace the value which is displayed, with the login information for your user account (username:password Base64 encoded) as Basic Authentication. In PHP it is done like this: $basic_auth_string = 'Basic ' . base64_encode($your_email . ':' . $your_password);. Your username is the email address you have registered with the customer support.

Requests and responses will expect/deliver the content type JSON /HAL. Each request will also return a HTTP status code.

The Client-API will be accessible via different versions. The default version will always be the oldest supported one. To use a specific version, the content-type needs to be changed.
For example: application/vnd.status.v2+json instead of application/json. Our recommendation for you is, not to indicate the specific version - if you still want to, please note, that we will delete older and broken versions, in order to ensure data security.

Each service has its own documentation, which provides all necessary information for implementation, including the request URL, request parameters plus valid values, response parameters and the allowed HTTP methods.

You will find the documentation of the services at the end of this general part.


Our services are grouped in three different APIs:

It is only allowed to perform operations for customers and their properties if they are related to and activated for your Client-API user account (needs verification from customer). You can add new customers to your account with the Customer service in the Account API. If you should not be able to modify your customer's data, please ask them to use the activation link in out email and/or check for this mail in your spam folder before contacting our API support team.


Documentation

Available APIs

API Versions
Listing v1 | v2
Customer v1 | v2
Account v1 | v2