Quick3 database API

Denne artikkelen beskriver hvordan du kan hente data direkte til Excel fra Quick3 databasen ved hjelp av API'et

API

Quick3 har et web service API som gir deg mulighet for å hente data direkte til Excel (eller andre verktøy) for videre bearbeiding eller rapportering.  API'et returnerer data i JSON format, som kan håndteres direkte av for eksempel Excel.

Foreløpig er antallet tilgjengelige spørringer begrenset.  API'et bygges raskt ut med flere funksjoner etter hvert som ønsker og behov meldes inn fra brukerne. 

Tilgjengelige API funksjoner

Slik kommer du i gang

Opprette API tilgang

• Kontakte Quick Systems kundeservice for å få aktivisert API modulen (Abonnementskostnad er 350 kroner per måned)
• Opprett en API bruker (Lær å opprette ressurser her)
• Denne brukeren trenger kun et minimum av informasjon:
  • Navn slik at du kan finne den igjen enkelt
  • Den må være aktiv
  • Det må være huket av for at det er en API bruker
  • Når du lagrer ressursen vil det bli generert en API-nøkkel.  Denne bruker du for å gi Excel tilgang.

Teste tilkobling med Curl (eller tilsvarende verktøy)

Dette punktet kan du hoppe over hvis du ikke kjenner til Curl.  Men hvis du er er litt "teknisk" og kan benytte slike verktøy er det er rask og enkel måte å teste at tilgangen er i orden.

Curl eksempel: Hente saldobalanse for periode 202003:

curl -X GET https://q3.quick.no/<instans>/api/v1/dataRetrieval/retrieve/wsXTrialBalance?Parameters=202003 -H "Authorization: Token token=<token>"

der <instans> erstattes med hvilken Quick3 instans ditt firma benytter.  Dette ser du av adressefeltet i nettleseren, som i eksemplet her ProdShared012.

<token> erstattes med API-nøkkelen for brukeren du opprettet.

Koble til API'et fra Excel

Denne beskrivelsen gjelder for Excel for Office 365.  I eksemplet skal vi hente inn saldobalansen for periode 202003.  Deretter skal vi endre perioden til å være en variabel slik at det blir enkelt å oppdatere Excel-arket med data for en annen periode.

• Start Excel
• Velg "Fra Internett" i Data-menyen
• Velg "Avansert"
• Registrer nettadresse del 1 og 2 dialogen (sammenhengende uten mellomrom eller linjeskift):
  • https://q3.quick.no/<instans>/api/v1/dataRetrieval/retrieve/wsXTrialBalance?Parameters=
  • 202003
• Legg til HTTP header:
  • Type: Authorization
  • Verdi: Token token=<token> (token henter du fra API-brukeren du opprettet)
• Klikk OK

• Velg Koble til

• Gi spørringen ønsket navn (f.eks. "Saldobalanse")
• Velg Til tabell for å gjøre om resultatsettet til en Excel-tabell
• Klikk OK (uten å endre innstillinger) or å gå videre

• Klikk på ekspander-knappen for å ekspandere kolonnene (velg eventuelt bort de kolonnene du ikke ønsker å ta med)
• Klikk OK

• Vi vil nå gjøre om det faste periodevalget til å være et parameter slik at dette blir enklere å endre senere
• Klikk på Behandle parametere og velg Ny parameter

• Gi parameteret et navn, 
• Velg type "Tekst" (du skal alltid velge type tekst)
• Legg inn en gjeldende verdi og klikk OK

• Klikk på tannhjulet ved Kilde for å redigere oppsettet av nettadresse
• Endre typen for del 2 til fra å være fast til å være en variabelen Periode.
• Klikk OK 

• Sett fokus tilbake til "Utvidet" og trykk Lukk og last inn for å laste dataene inn i Excel-arket.

• ...og Voila!

• Hvis du nå ønsker å oppdatere regnearket med data for en annen periode dobbeltklikker du bare på parameteret "Periode" for å angi ny periode.
• Deretter høyreklikker du på Saldobalanse og velger "Oppdater" for å hente nye verdier fra databasen