|
Installation |
  
|
|
Installation |
|
Beschreibung
Damit der Datenzugriff auf die MERCATOR API funktionieren kann, muss diese installiert und konfiguriert werden.
Die API ist nicht Teil der normalen MERCATOR Installation und ist daher gesondert zu betrachten.
Systemvoraussetzungen
Um die MERCATOR API installieren zu können, sind folgende Systemeigenschaften auf dem Server* Voraussetzung:
*als Server fungiert hier der Computer, auf dem MERCATOR und die SQLBase Datenbank vorhanden ist
| • | .NET Framework 4.0 |
| • | funktionstüchtige Installation von MERCATOR und der SQLBase Datenbank |
| • | Möglichkeit zum Setup des IIS (Microsoft Internet Information Services) |
Installation
Die MERCATOR API steht als REST Web-API zur Verfügung, die innerhalb des Microsoft IIS installiert werden muss.
Der Webserver IIS kann ab Windows 7 ohne zusätzliche Kosten einfach aktiviert und konfiguriert werden.
Je nach Betriebssystem und Anforderung kann die Einrichtung unterschiedlich komplex werden.
Das folgende Setup dient daher als Beispiel und ist nicht verbindlich auf jede Systemlandschaft übertragbar.
1. IIS aktivieren
| • | Windows > Programme und Funktionen > Windows Funktionen aktivieren oder deaktivieren |
| • | "Internetinformationsdienste" aktivieren (FTP, Webverwaltungstool, WWW-Dienste) |
2. ASP.NET 4 registrieren
| • | Windows cmd öffnen |
| • | Befehl cd C:\Windows\Microsoft.NET\Framework\v4.0.30319\ |
| • | Befehl aspnet_regiis.exe -ir |
| • | IIS öffnen durch Programme/Dateien suchen mit dem Begriff inetmgr |
| • | Seite verwalten/anlegen (die Standard Website ist auch nutzbar) |
| • | ASP.NET 4.0 zur Seite hinzufügen durch Sites > Website auswählen > Erweiterte Einstellungen > Anwendungspool > ASP.NET v4.0) besondere Nutzer sind nicht notwendig, Pass By Auth. |
| • | Anwendungspools > ASP.NET v4.0 auswählen > erweiterte Einstellungen > 32-Bit-Anwendungen auf True setzen |
| • | Anwendungspools > ASP.NET v4.0 auswählen > erweiterte Einstellungen > Startmodus auf AlwayRunning setzen |
3. API hinterlegen und konfigurieren
| • | MERCATOR API im definierten wwwroot Ordner des IIS kopieren (Zielordner: IIS Manager > Website Rechtsklick > im Explorer öffnen) |
| • | dataProviderConnectionString innerhalb der Web.Config mit dem Pfad zur SQL Konfig. Datei anpassen: |
<appSettings>
<add key="dataProviderConnectionString" value="DataSource={0};UserId={1};Password={2};ini=C:\\SQLBase115\\sql.ini" />
...
</appSettings>
Passen Sie nur den Pfad zur lokalen sql.ini an, wobei jedes Backslash doppelt angegeben werden sollte.
Ein allgemeiner Ausschluss von bestimmten Mandanten vom API Zugriff ist ebensfalls möglich.
Unterhalb des dataProviderConnectionString Tags finden Sie den Bereich der excludedClients, in dem Sie eine Liste von Mandanten (Komma getrennt) angeben können.
Im folgenden Beispiel werden die Mandanten mand004 und mand005 prinzipiell vom externen Zugriff ausgeschlossen, ganz unabhängig von den übertragenen Benutzerdaten:
<appSettings>
...
<add key="excludedClients" value="mand004,mand005"/>
</appSettings>
Falls Sie keine Mandanten explizit ausschließen möchten, können Sie das XML-Tag in seinem ursprünglichen Zustand belassen.
Die API ist nun im lokalen Netzwerk verfügbar (ein Neustart des IIS innerhalb des IIS Managers kann notwendig sein)
Um den erfolgreichen Status der API zu prüfen, können Sie im Internet-Browser nach Wahl diese aufrufen, z.B. http://192.168.1.1/api/mand001/status
Nach der Eingabe werden Sie nach Ihrem MERCATOR Benutzernamen und Passwort gefragt und autorisiert.
Weitere Infos zur URL Struktur gibt es auf der allgemeinen Hilfe-Seite der API.
4. API von außen erreichen
Im folgenden Beispiel wird über DynDNS bzw. DDNS Einstellungen eines externen Hosters (Beispiel: all-inkl.com) und dem lokalen Internet-Router
(Beispiel: FRITZ!Box) eine fest definierte URL zu Ihrem Webserver bzw. Ihrer API hergestellt:
| • | FRITZ!Box > Internet > Freigaben > Portfreigaben |
| • | Gerät für Freigaben: Computer (mit fester IP), auf dem die Datenbank bzw. der IIS läuft |
| • | HTTP Freigabe (auf den gleichen Port, auf den der IIS lauscht bzw. konfiguriert wurde) |
| • | all-inkl.com > Tools > DDNS Einstellungen |
| • | dort die DDNS Daten auf die der FRITZ!Box unter FRITZ!Box > Internet > Freigaben > DynDNS übertragen Beispiel: https://all-inkl.com/wichtig/anleitungen/kas/tools/ddns-dynamisches-dns/einrichtung-fritzbox-7320_364.html |
Anschließend ist die API (bzw. Ihr zuvor eingerichteter Webserver) über die definierte URL erreichbar.
Welche Datenbereiche vorhanden sind finden Sie hier: API Datenbereiche