***********************'*********************** ** USE ** *********************************************** ** AACHEN APP API ** ** api.aachen-app.de ** *********************************************** Use TXT for -> https://api.aachen-app.de/public/in-app/notification-banner/get.json JSON overview site -> https://api.aachen-app.de/in-app/notification-banner ***********************'*********************** ** Table of contents ** *********************************************** ** 1. General ** ** Before using ** ** 2. The JSON ** ** Construction ** ** Example ** *********************************************** *********************************************** ** 1. General ** *********************************************** ** Before using ** Please search for the JSON licence on the overview site and check if you can use the API and how much and until which date. This is important to provide errors on your integration. *********************************************** ** 2. The JSON ** *********************************************** ** Construction ** "active" = Shows you whether the API is currently on. true=yes, false=no (boolean) "news" = Contains all banners as objects. (array) "title" = Title of this banner. (string) "subtitle" = Subtitle of this banner. Could end on an exclamations or question mark. (string) "text" = A longer description of the banner. No maximum line. Markdown included: \n=new line (string) "img" = URL to PNG image. Sizes: width=1140px, height=680px (string) "imgAlt" Alternative text for the "img" image. "aboveVersion" = The banner is only displayed above this application version. If its empty its on false. (int) or (boolean) "belowVersion" = The banner is only displayed below this application version. If its empty its on false. (int) or (boolean) "onlyVersions" = Array of ints with of version the banner is displayed on. If its empty its on false. (array) or (boolean) "excludeVersions" = Array of ints with of version the banner is not displayed on. If its empty its on false. (array) or (boolean) "displayAd" = If this banner is an ad. true=yes, false=no (boolean) "link" = The URL the banner links to. (string) "onlyBusiness" = If the banner is only displayed for business acconuts. true=yes, false=no (boolean) "onlyPlatform" = Array of string with of plattforms the banner is not displayed on. Only: "android", "ios". If its empty its on false. (array) or (boolean) ** Example ** { "active": true, "news": [ { "title": "Example Banner Title", "subtitle": "Example Banner Subitle!", "text": "This text is about the example banner.\nIt contains the markdown.", "img": "example.url.fj/img.png", "imgAlt": "Example alternative text", "aboveVersion": false, "belowVersion": 34, "onlyVersions": false, "excludeVersions": 30, "displayAd": false, "link": "https://example.url.fj", "onlyBusiness": false, "onlyPlatform": false }, { "title": "Aachen App Update", "subtitle": "Neue Features", "text": "Jetzt die neue Version laden:\n• Design Anpassung\n• Performance Verbesserung\n• Testzentren integriert", "img": "https://api.aachen-app.de/public/in-app/notification-banner/content/update-yellow.png", "imgAlt": "Aachen App Update verfügbar", "aboveVersion": false, "belowVersion": false, "onlyVersions": 34, "excludeVersions": false, "displayAd": false, "link": "https://aachen-app.de/download", "onlyBusiness": false, "onlyPlatform": [ "ios" ] } ] }