API-tilgang Core (Informasjon til 3. parter)
For virksomheter som ønsker å lage en integrasjon med Core har vi samlet beskrivelser for oppstart av dette arbeidet på denne siden.
Vi ønsker generelt at det foreligger en avtale mellom integratører og minst en av våre kunder før integrasjonsarbeid startes.
Pris for integratører vil være en etableringskostand på kr 5.900,- samt 1.200,- per database (kunde) per måned. Dette inkluderer første gangs oppsett av API- tilganger for integratører mot kundebase og testmiljø (ihht bestilling fra integratøren).
API-support faktureres standard med kr 1.750,- eks mva pr time - og beregnes pr påbegynte halvtime.
Steg 1: API-avtale
Det første som må på plass når man skal integrere sitt produkt med Core, er en API-avtale. Dette er en avtale mellom BROKER by VISMA (tidligere Visma Real Estate) og integratøren og involverer ikke kunden.
Denne avtalen regulerer vilkår for utveksling av data mellom 3-part/integratøren sin løsning og BROKER by VISMA sine systemer.
For å få på plass en slik avtale kan integratøren sende en epost til [email protected] med følgende innhold:
Organisasjonsnummer:
Firmanavn:
Navn på signaturberettiget:
Epost til signaturberettiget:
Telefonnummer til signaturberettiget:
(vi sjekker signaturberettiget mot brreg.no)
Kunde(r) av BROKER by VISMA det skal integreres mot:
Kort beskrivelse av løsningen som skal integreres med Core:
Epost til teknisk kontaktperson hos integratøren (for mottak av api-nøkler):
Steg 2: Utsending og signering
Når informasjonen i steg 1 er mottatt, vil vår API-support sende ut API-avtalen til signering gjennom vårt system Visma Sign.
Signaturberettiget signerer for sitt firma og er klar til å gå videre.
Steg 3: Forespørsel om tilganger
NB: API-tilgang mot en kundebase i Core tilsvarer kjede-tilgang siden vi ikke kan avgrense dette mot et enkelt kontor. Denne forespørselen om tilganger må derfor godkjennes av kjedeledelsen hos kunden. Send gjerne forespørselen på epost til kjedeledelsen hos kunden først, og send deretter mailkorrespondansen videre til [email protected] - da har vi både forespørselen og bekreftelsen.
Eksempel
Hei Kjedeledelse x,
Vi trenger api-tilganger for å hente ut oppdragsdata fra deres kundebase i Core.
Kan du bekrefte “OK” på at vi får følgende api rettigheter:
Cases (Read)
CaseInformation (Read)
Sms (Read)
Emails (Read)
mvh
Integratøren
Tips:
For å finne frem til hvilke API-rettigheter man har behov for, vil det være nødvendig å sette seg godt inn i dokumentasjonen (se ressurser nedenfor).
Et konkret eksempel:
Integratøren har funnet ut at det er behov for å hente ut en liste over alle oppdrag. Rettigheter det skal samtykkes på finnes da slik:
Swagger - velg Core API Cases fra nedtrekksmeny oppe til høyre
Scroll ned til overskrift “Cases” - første endepunkt er GET /api/cases
Utvid denne ved å trykke på nedtrekksmeny - og øverst står det “Required permissions: Cases (Read)”
Ressurser:
API- dokumentasjon i Github
Swagger-dokumentasjon Legg merke til at hvert område i Swagger-dokumentasjonen har sin egen ReDoc-dokumentasjon
I tillegg til dette har vi laget en eksempelapplikasjon. Denne finner du her: https://github.com/Visma-Real-Estate-Solutions/Core.Api.Demo