Wir bieten verschiedene Schnittstellen an, damit Sie bestm\u00f6glich unsere Anwendung integrieren oder mit ihr interagieren k\u00f6nnen.<\/p>\n\n\n\n
F\u00fcr eine eindeutigen Aufruf unserer API wird immer ein piKey<\/strong> ben\u00f6tigt. Diesen erhalten Sie von Ihrem Ansprechpartner bei uns. S\u00e4mtliche Aufrufe setzen eine sichere Verbindung \u00fcber HTTPS<\/strong> voraus und Nachrichten im JSON<\/strong>-Format mit UFT-8<\/strong> codiert.<\/p>\n\n\n\n Als Beispiel verwenden wir Anfragen f\u00fcr unseren Demo-Campus in Hamburg. <\/p>\n\n\n\n Sie haben die M\u00f6glichkeit, die Anfrageparameter als URL-Parameter oder im Body im JSON-Format anzufragen. In unseren Beispielen werden wir der \u00dcbersicht halber nur die Body-Requests auff\u00fchren.<\/p>\n\n\n\n App-URLs<\/p>\n\n\n\n Wenn Sie unsere Anwendung z.B. innerhalb eines iFrames integrieren m\u00f6chten, dann ist es oftmals sinnvoll, nicht einfach nur die Startseite der Anwendung aufzurufen. Dabei haben Sie die M\u00f6glichkeit, 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\u00f6nnen. Zudem wird unsere Anwendung fortlaufend verbessert und erweitert, weshalb es besser ist \u00fcber die API die URL zu ermitteln, als sich das Ergebnis der API zu speichern. <\/p>\n\n\n\n Die M\u00f6glichkeiten und Auswirkungen sind in der folgenden Tabelle aufgef\u00fchrt:<\/p>\n\n\n\n Start & Destination<\/p>\n\n\n\n F\u00fcr die Navigation k\u00f6nnen Start- und Ziel angegeben werden. Da wir eventuell auf unterschiedlichen Fremdschl\u00fcsseln arbeiten, ermitteln wir anhand der Eingabe und der uns vorliegenden Daten die f\u00fcr unsere Navigation wichtigen Global IDs<\/strong>.<\/p>\n\n\n\n M\u00f6gliche Types:<\/p>\n\n\n\n HTTP Status Codes<\/p>\n\n\n\n Beispiele<\/p>\n\n\n\n #1<\/p>\n\n\n\n #2<\/p>\n","protected":false},"excerpt":{"rendered":" Wir bieten verschiedene Schnittstellen an, damit Sie bestm\u00f6glich unsere Anwendung integrieren oder mit ihr interagieren k\u00f6nnen. F\u00fcr eine eindeutigen Aufruf […]<\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"_et_pb_use_builder":"","_et_pb_old_content":"","_et_gb_content_width":"","_uag_custom_page_level_css":"","site-sidebar-layout":"default","site-content-layout":"","ast-site-content-layout":"default","site-content-style":"default","site-sidebar-style":"default","ast-global-header-display":"","ast-banner-title-visibility":"","ast-main-header-display":"","ast-hfb-above-header-display":"","ast-hfb-below-header-display":"","ast-hfb-mobile-header-display":"","site-post-title":"","ast-breadcrumbs-content":"","ast-featured-img":"","footer-sml-layout":"","theme-transparent-header-meta":"","adv-header-id-meta":"","stick-header-meta":"","header-above-stick-meta":"","header-main-stick-meta":"","header-below-stick-meta":"","astra-migrate-meta-layouts":"default","ast-page-background-enabled":"default","ast-page-background-meta":{"desktop":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"ast-content-background-meta":{"desktop":{"background-color":"var(--ast-global-color-4)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"var(--ast-global-color-4)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"var(--ast-global-color-4)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"footnotes":""},"epkb_post_type_1_category":[24],"epkb_post_type_1_tag":[],"class_list":["post-94","epkb_post_type_1","type-epkb_post_type_1","status-publish","hentry","epkb_post_type_1_category-api"],"uagb_featured_image_src":{"full":false,"thumbnail":false,"medium":false,"medium_large":false,"large":false,"1536x1536":false,"2048x2048":false,"et-pb-post-main-image":false,"et-pb-post-main-image-fullwidth":false,"et-pb-portfolio-image":false,"et-pb-portfolio-module-image":false,"et-pb-portfolio-image-single":false,"et-pb-gallery-module-image-portrait":false},"uagb_author_info":{"display_name":"Fiona Hackmann","author_link":"https:\/\/knowledge.catchup-apps.com\/?author=2"},"uagb_comment_info":0,"uagb_excerpt":"Wir bieten verschiedene Schnittstellen an, damit Sie bestm\u00f6glich unsere Anwendung integrieren oder mit ihr interagieren k\u00f6nnen. F\u00fcr eine eindeutigen Aufruf […]","_links":{"self":[{"href":"https:\/\/knowledge.catchup-apps.com\/index.php?rest_route=\/wp\/v2\/epkb_post_type_1\/94","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/knowledge.catchup-apps.com\/index.php?rest_route=\/wp\/v2\/epkb_post_type_1"}],"about":[{"href":"https:\/\/knowledge.catchup-apps.com\/index.php?rest_route=\/wp\/v2\/types\/epkb_post_type_1"}],"author":[{"embeddable":true,"href":"https:\/\/knowledge.catchup-apps.com\/index.php?rest_route=\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/knowledge.catchup-apps.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=94"}],"version-history":[{"count":5,"href":"https:\/\/knowledge.catchup-apps.com\/index.php?rest_route=\/wp\/v2\/epkb_post_type_1\/94\/revisions"}],"predecessor-version":[{"id":100,"href":"https:\/\/knowledge.catchup-apps.com\/index.php?rest_route=\/wp\/v2\/epkb_post_type_1\/94\/revisions\/100"}],"wp:attachment":[{"href":"https:\/\/knowledge.catchup-apps.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=94"}],"wp:term":[{"taxonomy":"epkb_post_type_1_category","embeddable":true,"href":"https:\/\/knowledge.catchup-apps.com\/index.php?rest_route=%2Fwp%2Fv2%2Fepkb_post_type_1_category&post=94"},{"taxonomy":"epkb_post_type_1_tag","embeddable":true,"href":"https:\/\/knowledge.catchup-apps.com\/index.php?rest_route=%2Fwp%2Fv2%2Fepkb_post_type_1_tag&post=94"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}Schnittstelle<\/strong>:\nhttps://www.catchup-apps.com\/api\/public\/getAppUrl.php<\/code><\/pre>\n\n\n\nParameter<\/th> Typ & Default Value<\/th> Pflichtfeld<\/th> Beschreibung<\/th><\/tr><\/thead> piKey<\/td> string: –<\/td> Ja<\/td> Eindeutige Bezeichnung f\u00fcr den Mandanten<\/td><\/tr> noIntro<\/td> boolean: true<\/td> Nein<\/td> true: \u00dcberspringt das Intro, sodass z.B. direkt die Karte dargestellt wird.
false: Das Intro wird dargestellt.<\/td><\/tr>isTerminal<\/td> boolean: false<\/td> Nein<\/td> true: Unsere Anwendung wird minimalistisch dargestellt, sodass der Benutzer nicht durch \u00fcberfl\u00fcssige Auswahlm\u00f6glichkeiten abgelenkt wird. Zudem besteht mit dieser Option die M\u00f6glichkeit, weitere Optionen freizuschalten.
false: Die Standardansicht wird verwendet.<\/td><\/tr>terminalHandAnimation<\/td> boolean: false<\/td> Nein<\/td> true: Nach einer gewissen Zeit wird auf der Karte eine „Hand“ dargestellt, die zur Interaktion mit dem Display animiert.
false: Die Standardansicht wird verwendet.<\/td><\/tr>navigationLock<\/td> boolean: false<\/td> Nein<\/td> true:
false: <\/td><\/tr>autoReset<\/td> boolean: false<\/td> Nein<\/td> true: Nach einer gewissen Zeit wird die Anwendung auf die Darstellung beim initialen URL-Aufruf zur\u00fcckgesetzt.
false: Die Anwendung setzt sich nicht automatisch zur\u00fcck.<\/td><\/tr>hideTabbar<\/td> boolean: true<\/td> Nein<\/td> 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\u00fcgbar.<\/td><\/tr>redirect<\/td> boolean: false<\/td> Nein<\/td> true: Die resultierende URL wird nicht zur\u00fcckgegeben, sondern direkt aufgerufen. Dies ist insbesondere in iFrames sinnvoll.
false: Wir liefern Ihnen im Response die nutzbare URL zur\u00fcck.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\nParameter<\/th> Typ<\/th> Pflichtfeld<\/th> Beschreibung<\/th><\/tr><\/thead> start<\/td> JSON: –<\/td> Nein<\/td> Tupel bestehend aus type<\/em> & id<\/em>, welches den Start der Navigation definiert.<\/td><\/tr> destination<\/td> JSON: –<\/td> Nein<\/td> Tupel bestehend aus type<\/em> & id<\/em>, welches das Ziel der Navigation definiert.<\/td><\/tr><\/tbody><\/table> Type<\/th> Beschreibung<\/th><\/tr><\/thead> agfaCalendarId<\/td> Dedalus Agfa-Kalender ID<\/td><\/tr> technicalRoomNumber<\/td> Technische Raumnummer (Aktuell die bei uns hinterlegten Fremdschl\u00fcssel)<\/td><\/tr> roomName<\/td> Raum Name (Aktuell de_DE von nameLabel)<\/td><\/tr> <\/td> <\/td><\/tr> <\/td> <\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n Code<\/th> Beschreibung<\/th><\/tr><\/thead> 200<\/td> OK<\/td><\/tr> 403<\/td> Start- oder Ziel-type nicht valide<\/td><\/tr> 404<\/td> F\u00fcr mindestens eines der angegebenen ID & Type-Tupel wurde kein Ergebnis gefunden<\/td><\/tr> <\/td> <\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n Request (Body)<\/strong> an https:\/\/www.catchup-apps.com\/api\/public\/getAppUrl.php\n{\n \"piKey\": \"Basispaket-vZLgxvdW6PH8sK24Epj2RmOSUpag10etaFaFJb8\",\n \"destination\": {\n \"type\": \"roomName\",\n \"id\": \"Raum EG\"\n },\n \"redirect\": false\n}\n<\/code><\/pre>\n\n\n\nResponse<\/strong>\nhttps:\/\/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\"]<\/code><\/pre>\n\n\n\n