Security Checks
The API uses different access checks depending on the endpoint. Some calls require a portal token, others require an XML token or an authenticated user session. Rate limits may apply to selected endpoints. If an endpoint is intended for external systems, treat all tokens like passwords and do not expose them publicly.
Channel Manager API
Fetch Stations
Endpoint: GET /run_channelmanager_result.php?call=fetchstations&portal={portal}
Returns a list of available stations.
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
portal | Integer | Yes | Customer number of the portal. | 71 |
Relations
Endpoint: GET /run_channelmanager_result.php?call=relations&portal={portal}&station_id={station_id}&date={date}&zielstation_id={zielstation_id}&hidePrice={hidePrice}&hideRueckfahrt={hideRueckfahrt}&lhf_id={lhf_id}&linie_id={linie_id}
Returns schedule data and connections between two stations for a specific date.
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
portal | Integer | Yes | Customer number of the portal. | 71 |
station_id | Integer | Yes | Departure station ID. | 1 |
date | String | Yes | Date in YYYY-MM-DD format. | 2023-10-01 |
zielstation_id | Integer | Yes | Destination station ID. | 2 |
hidePrice | Boolean | No | true or false. | false |
hideRueckfahrt | Boolean | No | true or false. | false |
lhf_id | Integer | No | Line-station entry ID. | 3 |
linie_id | Integer | No | Line ID. | 5 |
Availability
Endpoint: GET /run_channelmanager_result.php?call=availability&portal={portal}&product={product}&start={start}&stop={stop}
Checks availability for a product over a defined period.
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
portal | Integer | Yes | Customer number of the portal. | 71 |
product | String | Yes | Product ID. | 12345 |
start | String | Yes | Start date and time. | 2023-10-01 10:00:00 |
stop | String | Yes | End date and time. | 2023-10-01 12:00:00 |
Cancel
Endpoint: GET /run_channelmanager_result.php?call=cancel&portal={portal}&booking_reference={booking_reference}
Cancels an existing reservation by booking reference.
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
portal | Integer | Yes | Customer number of the portal. | 71 |
booking_reference | Integer | Yes | Booking reference. | 123456 |
Booking
Endpoint: POST /run_channelmanager_result.php?call=booking
Creates a new booking and returns booking details.
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
product | String | Yes | Product ID. | 12345 |
customer | String | Yes | Customer name. | Max Mustermann |
customer_first_name | String | Yes | Customer first name. | Max |
email | String | Yes | Customer email address. | max@mustermann.de |
phone | String | No | Customer phone number. | 0123456789 |
date | String | Yes | Booking date in YYYY-MM-DD format. | 2023-10-01 |
ticket | Array | Yes | Tickets with type and quantity. | [{"id":1,"type":1,"quantity":2}] |
Schedule Output API
The run_fahrplan_ausgabe.php endpoint provides schedule-related calls for external systems.
| Call | Endpoint | Description |
|---|---|---|
| Event calendar | run_fahrplan_ausgabe.php?aktion=eventcalendar | Generates a calendar for events linked to line and station IDs. |
| Trip search | run_fahrplan_ausgabe.php?aktion=fahrtsuche | Searches available trips based on station, date range, and line type. |
| Categories | run_fahrplan_ausgabe.php?aktion=listcategories | Returns categories relevant for lines and trips. |
| Traffic days | run_fahrplan_ausgabe.php?aktion=verkehrstage | Returns operating days for a line and date range. |
| Find | run_fahrplan_ausgabe.php?aktion=finden | Searches trips based on line IDs, line type, and date. |
| Traffic days mode | run_fahrplan_ausgabe.php?modus=verkehrstage | Returns traffic days using mode-based parameters. |
Typical parameters include station IDs, line IDs, line type IDs, start and end dates, and optional display flags such as newwindow or godirect.
XML API v1
The xml_v1.php API uses token and session checks for protected calls. Valid tokens are required for most actions.
| Action | Endpoint | Description |
|---|---|---|
| Background image | GET /xml_v1.php?aktion=background_image | Returns the background image URL or a default image. |
| Customer app bookings | GET /xml_v1.php?aktion=getBuchungen&kundennummer=123&email=test@example.com | Returns bookings for a customer. |
| Token protection | GET /xml_v1.php | Checks whether the token is valid. |
| Live capacity | GET /xml_v1.php?aktion=checkLiveCapacity&datum=2023-10-01&hafen_id=1&linie_hafen_fahrplan_id=2 | Checks availability for a date and station. |
| Login | POST /xml_v1.php?aktion=login | Authenticates a user and returns user data. |
| Cancel booking | GET /xml_v1.php?aktion=storno&reservierung_id=1 | Cancels a booking by reservation ID. |
| Payment methods | GET /xml_v1.php?aktion=getZahlarten | Returns available payment methods. |
| Voucher value | GET /xml_v1.php?aktion=checkGutscheinValue&gutscheincode=ABC123&reservierung_id=1 | Checks the value of a voucher. |
| Tickets | GET /xml_v1.php?aktion=getTickets&datum_start=2023-10-01&datum_stop=2023-10-31 | Returns tickets in a date range. |
| Items | GET /xml_v1.php?aktion=getArtikel&kategorie_id=1&online=true | Returns items from a category. |
| Traffic days | GET /xml_v1.php?aktion=verkehrstage&linie_id=1 | Returns traffic days for a line. |
| Insert reservation | POST /xml_v1.php?aktion=insertReserveration | Creates a new reservation from JSON data. |
XML API v2
The xml_v2.php API is secured through token validation. Tokens can be passed through GET or POST requests.
| Call | Endpoint | Description |
|---|---|---|
| Charter types | GET /xml_v2.php?call=purp | Returns available charter or booking purpose types. |
| Locations | GET /xml_v2.php?call=locations | Returns available locations including region and operator IDs. |
| Resources | GET /xml_v2.php?call=ressources | Returns available resources, for example ships. |
| Place reservation | GET /xml_v2.php?call=place | Reserves a resource with the provided parameters. |
| Check item | GET /xml_v2.php?call=checkItem | Checks item validity by barcode. |
| Cancel | GET /xml_v2.php?call=cancel | Cancels a reservation by booking number. |
| Price types | GET /xml_v2.php?call=getPriceTypes | Returns available price types. |
| Product keys | GET /xml_v2.php?call=getProductKeys | Returns product keys for a portal. |
| Ratings | GET /xml_v2.php?call=ratings | Returns ratings for a line. |
| Customer data | GET /xml_v2.php?call=getCustomer | Returns customers based on customer category. |
| Bookings | GET /xml_v2.php?call=getBookings | Returns bookings for a specific date. |
Each call has specific parameters and should be tested with the relevant account configuration before productive use.