Versions Compared

Version Old Version 12 New Version 13
Changes made by

Anders Abrahamsen

Anders Abrahamsen

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Dette kan også benyttes indirekte til å oversette et svar i JSON til norsk for enhver ressurs ved å legge til parameter:AcceptLanguage:Norwegian. (Denne funksjonen er for øyeblikket ikke tilgjengelig!)

Generell beskrivelse

EDR Realty RestAPI er benytter rene REST-operasjoner. Resultatet leveres som JSON-dokumenter.

REST: REST (Representational State Transfer) er designet for å utnytte eksisterende protokoller. REST kan brukes over nesten hvilken som helst protokoll (vanligvis benyttes HTTP når i web-APIer). Utviklere ikke trenger å installere biblioteker eller tilleggsprogramvare for å kunne dra nytte av en REST API. REST API Design ble definert av Dr. Roy Fielding i sin 2000 doktorgradsavhandling. Det er kjent for sitt utrolige lag av fleksibilitet. For nærmere beskrivelse se:https://en.wikipedia.org/wiki/Representational_state_transfer

JSON: JSON (JavaScript Object Notation) er en enkel tekstbasert standard for å formatere meldinger som brukes for datautveksling. Den er opprinnelig avledet fra JavaScript for å representere enkle datastrukturer. Standarden er imidlertid uavhengig av JavaScript eller andre programmeringsspråk. For ytterligere informasjon, se: https://json.org/

Konvolutt: Vi har valgt å bruke konvolutt i stedet for et JSON-element eller et JSON-array. Tjenestene svarer med data i JSON-formatet med en konvoluttstruktur i retur. Konvolutten inneholder en liste over elementer fra søkeressursen (List<Item>, Pagination og Error) eller generell oppslagsressurs (Item og Error)

Ident og nøkkel: Et objekt er identifisert ved hjelp av en ident. En ident kan bestå av flere felter. For eksempel er identen til en eiendom kommunenr, gardsnr, bruksnr, festenr og seksjonsnr. 

...

Autentisering: Ambita sine APIer bruker en egenimplementert autentisering som følger OAuth2. Alle kall mot APIet må inneholde en header parameter som ser slik ut

Code Block
Authorization: Bearer <UUID token>

Man får tak i et token ved å kalle authentication på URL for beta:

POST https://beta-api.ambita.com/authentication/v2/token med enten:

  • client_credentials flow: client_id og client_secret
    Dette brukes for sikker server til server kommunikasjon

  • non confidential password flow: client_id, bruker og passord

Se: Swagger UI create token

Generell beskrivelse

EDR Realty RestAPI er benytter rene REST-operasjoner. Resultatet leveres som JSON-dokumenter.

REST: REST (Representational State Transfer) er designet for å utnytte eksisterende protokoller. REST kan brukes over nesten hvilken som helst protokoll (vanligvis benyttes HTTP når i web-APIer). Utviklere ikke trenger å installere biblioteker eller tilleggsprogramvare for å kunne dra nytte av en REST API. REST API Design ble definert av Dr. Roy Fielding i sin 2000 doktorgradsavhandling. Det er kjent for sitt utrolige lag av fleksibilitet. For nærmere beskrivelse se:https://en.wikipedia.org/wiki/Representational_state_transfer

JSON: JSON (JavaScript Object Notation) er en enkel tekstbasert standard for å formatere meldinger som brukes for datautveksling. Den er opprinnelig avledet fra JavaScript for å representere enkle datastrukturer. Standarden er imidlertid uavhengig av JavaScript eller andre programmeringsspråk. For ytterligere informasjon, se: https://json.org/

Konvolutt: Vi har valgt å bruke konvolutt i stedet for et JSON-element eller et JSON-array. Tjenestene svarer med data i JSON-formatet med en konvoluttstruktur i retur. Konvolutten inneholder en liste over elementer fra søkeressursen (List<Item>, Pagination og Error) eller generell oppslagsressurs (Item og Error)

Ident og nøkkel: Et objekt er identifisert ved hjelp av en ident. En ident kan bestå av flere felter. For eksempel er identen til en eiendom kommunenr, gardsnr, bruksnr, festenr og seksjonsnr. 

Code Block
 ident: {
   municipalityNumber:301,
   cadastralUnitNumber:1,
   unitNumber:1,
   leaseholdUnitNumber:0,
   sectionNumber:0,
   section:false
 }

...

  • Query: Tegn for tegn søk (som for eksempel ønsket antall tegn i et gatenavn for å få returnert alle gater som starter med den oppgitte tegnstrengen. Krav om at minimum 3 tegn oppgis. Søk foretas v.h.a. elastic seach engine for å ivareta ulike skrivemåter, ulik rekkefølge på felter, m.v.

  • Oppslag: Oppslag med relaterte identer (som for eksempel oppslag med adresse for å finne en eiendom der en ikke kjenner eiendommens matrikkel). Ved opplag v.h.a. relaterte identer returneres lister med ingen, en eller flere forekomster.

...

  • . Ved opplag v.h.a. relaterte identer returneres lister med ingen, en eller flere forekomster.

...

Lenker fra ressursene går til Realty beta av Swagger UI for APIet vårt. Dette gjør vi fordi de som starter å ta i bruk APIet ikke har produksjonstilgang. Da er det lettere å gjøre testing mot beta.

Hovedlenke til swagger for beta og prod miljø er: Swagger UI Realty Beta og Swagger UI Realty Prod

Opplisting av ressurser:

...