API

Wir bieten verschiedene Schnittstellen an, damit Sie bestmöglich unsere Anwendung integrieren oder mit ihr interagieren können.

Für eine eindeutigen Aufruf unserer API wird immer ein piKey benötigt. Diesen erhalten Sie von Ihrem Ansprechpartner bei uns. Sämtliche Aufrufe setzen eine sichere Verbindung über HTTPS voraus und Nachrichten im JSON-Format mit UFT-8 codiert.

Als Beispiel verwenden wir Anfragen für unseren Demo-Campus in Hamburg.

Sie haben die Möglichkeit, die Anfrageparameter als URL-Parameter oder im Body im JSON-Format anzufragen. In unseren Beispielen werden wir der Übersicht halber nur die Body-Requests aufführen.

App-URLs

Wenn Sie unsere Anwendung z.B. innerhalb eines iFrames integrieren möchten, dann ist es oftmals sinnvoll, nicht einfach nur die Startseite der Anwendung aufzurufen. Dabei haben Sie die Möglichkeit, verschiedene Einstellungen vorzunehmen. Unsere Anwendung ist so aufgebaut, dass alle notwendigen Parameter in der URL hinterlegt sind. Dies hat z.B. den Vorteil, dass Benutzer unserer Anwendung die Navigation von Start zum Ziel direkt teilen können. Zudem wird unsere Anwendung fortlaufend verbessert und erweitert, weshalb es besser ist über die API die URL zu ermitteln, als sich das Ergebnis der API zu speichern.

Die Möglichkeiten und Auswirkungen sind in der folgenden Tabelle aufgeführt:

Schnittstelle:
https://www.catchup-apps.com/api/public/getAppUrl.php

Parameter	Typ & Default Value	Pflichtfeld	Beschreibung
piKey	string: –	Ja	Eindeutige Bezeichnung für den Mandanten
noIntro	boolean: true	Nein	true: Überspringt das Intro, sodass z.B. direkt die Karte dargestellt wird. false: Das Intro wird dargestellt.
isTerminal	boolean: false	Nein	true: Unsere Anwendung wird minimalistisch dargestellt, sodass der Benutzer nicht durch überflüssige Auswahlmöglichkeiten abgelenkt wird. Zudem besteht mit dieser Option die Möglichkeit, weitere Optionen freizuschalten. false: Die Standardansicht wird verwendet.
terminalHandAnimation	boolean: false	Nein	true: Nach einer gewissen Zeit wird auf der Karte eine „Hand“ dargestellt, die zur Interaktion mit dem Display animiert. false: Die Standardansicht wird verwendet.
navigationLock	boolean: false	Nein	true: false:
autoReset	boolean: false	Nein	true: Nach einer gewissen Zeit wird die Anwendung auf die Darstellung beim initialen URL-Aufruf zurückgesetzt. false: Die Anwendung setzt sich nicht automatisch zurück.
hideTabbar	boolean: true	Nein	true: Die Tabbar wird ausgeblendet, sodass der Benutzer z.B. nur die Navigation verwenden kann. false: Alle Funktionen der Tabbar, z.B. Neuigkeiten oder Veranstaltungen, sind verfügbar.
redirect	boolean: false	Nein	true: Die resultierende URL wird nicht zurückgegeben, sondern direkt aufgerufen. Dies ist insbesondere in iFrames sinnvoll. false: Wir liefern Ihnen im Response die nutzbare URL zurück.

Start & Destination

Für die Navigation können Start- und Ziel angegeben werden. Da wir eventuell auf unterschiedlichen Fremdschlüsseln arbeiten, ermitteln wir anhand der Eingabe und der uns vorliegenden Daten die für unsere Navigation wichtigen Global IDs.

Parameter	Typ	Pflichtfeld	Beschreibung
start	JSON: –	Nein	Tupel bestehend aus type & id, welches den Start der Navigation definiert.
destination	JSON: –	Nein	Tupel bestehend aus type & id, welches das Ziel der Navigation definiert.

Mögliche Types:

Type	Beschreibung
agfaCalendarId	Dedalus Agfa-Kalender ID
technicalRoomNumber	Technische Raumnummer (Aktuell die bei uns hinterlegten Fremdschlüssel)
roomName	Raum Name (Aktuell de_DE von nameLabel)

HTTP Status Codes

Code	Beschreibung
200	OK
403	Start- oder Ziel-type nicht valide
404	Für mindestens eines der angegebenen ID & Type-Tupel wurde kein Ergebnis gefunden

Beispiele

#1

Request (Body) an https://www.catchup-apps.com/api/public/getAppUrl.php
{
    "piKey": "Basispaket-vZLgxvdW6PH8sK24Epj2RmOSUpag10etaFaFJb8",
    "destination": {
        "type": "roomName",
        "id": "Raum EG"
    },
    "redirect": false
}

Response
https://www.catchup-apps.com/app/map/info/?piKey=Basispaket-vZLgxvdW6PH8sK24Epj2RmOSUpag10etaFaFJb8&noIntro=true&navigationLock=false&hideTabbar=true&isTerminal=false&autoReset=false&terminalHandAnimation=false&destination=1489563&campusKeys=["KPMKjRtTWcgP6oK2355txKLi7orfr6bxjxxp55CkSlh57KhgQQ"]

#2