Adressök

Grundförutsättning

Det finns två saker som behöver göras innan webappen är redo för användning och det är följande.

  1. En Key/value Data Store Länk till annan webbplats, öppnas i nytt fönster. måste finnas med namnet "NetAdminAPI"
    1.1 Adressöket (webappen) måste sedan tilldelas åtkomst till Data Storen
  2. Inställningarna för adressöket måste fyllas i (det är viktigast att allt under rubriken API fylls i). Inställningarna hittas under: Mallar --> Redaktörsmallar --> Adressök. Gå till Adressöksmodulen i innehållsytan och dubbelklicka på den för att få upp inställningarna (se skärmdumpar nedan).
Mallar
Mallar_adressök

Autentisering

För att kunna hämta adresser från NetAdmins API måste webappen först hämta en OAuth 2.0 token. Tokenen behöver skickas med i varje request som görs för att hämta adresser. Den är giltig i 24 timmar och efter det så måste en ny token hämtas.

För att kunna hämta tokenen så kan ett GET anrop göras mot den här endpointen https://login.halmstadsstadsnat.se/oauth2/token med följande parametrar: client_id=1f208883-705a-41c4-9aef-4ac1da4c890d&client_secret=IkzSgwjfOkoXQbSbyi8Qo6TYh00pnrvJ80T1barKAfs=&grant_type="password"&username=HSAB%20Web&password=64k7Gy@ZAmLUhR

En komplett URL ser alltså ut såhär: https://login.halmstadsstadsnat.se/oauth2/token?client_id=1f208883-705a-41c4-9aef-4ac1da4c890d&client_secret=IkzSgwjfOkoXQbSbyi8Qo6TYh00pnrvJ80T1barKAfs=&grant_type="password"&username=HSAB%20Web&password=64k7Gy@ZAmLUhR

Ifall en token redan har hämtats och det inte har passerat 24 timmar så kommer inte en ny token hämtas. Den kommer istället hämtas från en Data Store där den lagrats. När en ny token hämtas kommer den byta ut den token som finns lagrad i Data storen och webappen kommer börja använda den nya tokenen.

Sökning

När det finns en giltig token så kan sökningar göras och ett GET anrop för att hämta adresser kan exempelvis se ut såhär:
https://login.halmstadsstadsnat.se/api/addresses?street.name=stora%20v&itemsPerPage=1000

I det ovanstående anropet söker vi efter adresser vars namn innehåller "stora v" och vi får maximalt tillbaka 1000 adresser.

Modal

I inställningarna för adressöket så går det att styra vart länkarna i de olika modalerna ska länka till.

Paginering

Det finns även möjlighet i inställningarna att styra hur många sökresultat som ska synas på en sida.