Dokumentation för installation av enhetsdatabasen och enhetsadmin

Inledning

Dokumentationen omfattar installationsbeskrivning och den information om den konfiguration som krävs för sätta upp en enhetsdatabas med administrationsgränssnitt samt ett REST-api för kommunikation från enhetsdatabasen.

Filer och resurser

Filer

Version Adress
Binärer och databasscript för Restful API http://api.stockholm.se/files/restapi.zip
Binärer och databasscript för enhetsadmin http://api.stockholm.se/files/ServiceGuide.zip

Resurs Adress
Dokumentation konsumering API http://api.stockholm.se/dokumentation
Dokumentation administrationsgränssnitt för enhetsdatabas http://www.stockholm.se/-/Publicera/Mallar/Enhetsadmin/

Uppsättning enhetsdatabas

  1. Packa upp paketet ServiceGuide.zip
  2. Kör alla scripts i den ordning de är döpta under "\Install scripts\1. Database". Se även den readme.txt under samma katalog.
  3. För defaultinnehåll i databasen, var vänlig granska innehållet i "Install scripts\2. Default database content". Dessa innehåller data som ej kan administreras i gränssnittet. De innehåller de informationsfält och data som används för enhetsdatabasen som Stockholm.se använder, men kan anpassas till just ert projekt här.

Uppsättning administrationsgränssnitt

Förutsättnng för följande instruktioner är en fungerande uppsatt IIS-site

  1. Öppna SettingsFileGenerator.xls och se till att makron är tillåtna
  2. Modifiera alla konfigurationsinställningar i kolumnen EA Test Environment
  3. Spara filen och tryck CTRL+W för att exportera ut inställningarna som xml
  4. Kör DeployToTarget.bat med WebDirectory, XmlName (namn på xml-filen för den valda miljön, ej med .xml), Stockholm.Web
    Exempelvis: DeployToTarget.bat C:\WebDirectory ea_test-environment Stockholm.Web

Uppsättning databas för API-nycklar

  1. Packa upp paketet restapi.zip
  2. Kör script under "Install scripts\1. Database"

Uppsättning REST-api

Förutsättnng för följande instruktioner är en fungerande uppsatt IIS-site

  1. Öppna SettingsFileGenerator.xls och se till att makron är tillåtna
  2. Modifiera alla konfigurationsinställningar i kolumnen Test Environment
  3. Spara filen och tryck CTRL+W för att exportera ut inställningarna som xml
  4. Kör DeployToTarget.bat med WebDirectory, XmlName (namn på xml-filen för den valda miljön, ej med .xml), Stockholm.Web
    Exempelvis: DeployToTarget.bat C:\WebDirectory test-environment Stockholm.Web.Api

Användare

Användarehanteringen till alla ovanstående är beroende av en katalogtjänst och använder .NET-s membership providers. Det är alltså fullt möjligt att byta till valfri provider och följdaktligen modifiera konfigurationen.

Information samt exempel på hur APIet kan användas

Se http://api.stockholm.se/dokumentation för mer information.