Gå til hovedinnhold

API-tilgang Core (Informasjon til 3. parter)

Oppdatert for over en måned siden

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.

Det vil være en etableringskostnad for integratør, i tillegg til en månedlig kostnad per database(kunde) integratøren får tilgang til. Etableringskostnad 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 1750,- 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 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 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 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.

Alternativt kan dere sende bestillingen på api direkte til [email protected] med kunden på kopi. Det er viktig dere får med ønskede scope's (api permissions i Scalar api dokumentasjon) og ber kunden samtykke på tilgang.

Eksempel

Hei Kjedeledelse x,

Vi trenger api-tilganger for å hente ut oppdragsdata fra deres kundebase i Core.

Kan du bekrefte at vi kan få 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:

  • Scalar - velg Core API Cases fra nedtrekksmeny oppe til venstre

  • Scroll ned til overskrift “Cases” - første beskrivelse er "Returns a list of all cases accessible to the current user." Endepunktet er GET /api/cases

  • I beskrivelsen av endepunktet er det notert
    "Required permissions: Cases (Read)"

Ressurser:

Svarte dette på spørsmålet?