Kom i gang med APIet

Vi tilbyr et GraphQL API 🤓

We also have an English version of this article available

Kom i gang

1. Gi din bruker tilgang

APIet vårt er basert på bruker, så du gir tilgang til APIet som den brukeren du er. Integrasjonen din vil da ha samme rettigheter som brukeren du er logget inn som. Dersom du vil at integrasjonen din skal ha begrensede rettigheter kan du opprette en ny bruker med de rettighetene til de selskapene du ønsker.

Vi har to måter å gi tilgang på

1. Lage en nøkkel direkte på en bruker
2. Benytte OAuth2

Metode 1, med direkte nøkkel, er enklest og fungerer fint når man skal teste APIet, dersom man lager en integrasjon med lite utbredelse, eller man har god kontroll på hvilke brukere som skal benytte integrasjonen.

Metode 2, med OAuth2, er litt mer komplisert å implementere, og er best i de tilfellene hvor brukeren selv skal sette opp en integrasjon du har laget.

For å skru på API for en bruker med direkte nøkkel gjør du følgende

• Gå til Innstillinger > Brukere.
• Velg den riktige brukeren
• Velg Full tilgang på API-tilgang
• Klikk lagre

Oauth2-oppsett er beskrevet i egen artikkel

2. Opprette API-nøkkel

• Gå til Brukerinnstillinger (som den brukeren som skal ha tilgangen)
• Klikk på “Ny personlig API-nøkkel”
• Fyll ut Navn (valgfritt så du husker), utløpsdato (kan være tomt om du ønsker) og hvilket selskap det gjelder (om du har flere selskap)
• Klikk lagre
• Spar på den token som du så får

3. Bruke API-nøkkelen

GraphQL-API et finnes på /api/v1/graphql (så f.eks. https://go.lucaregnskap.no/api/v1/graphql for produksjonstilgang). Du må sette headeren Authorization til Bearer JWT_TOKEN hvor JWT_TOKEN er den token som ble opprettet i steg 2.

4. Første eksempellkall

Nå burde du kunne kjøre:

{ saleInvoices { nodes { id } } }

Dokumentasjon av tilgjengelige kall

Du kan bruke GraphQL sin innebygde dokumentasjonsserver. De fleste API-verktøy støtter dette, f.eks. i Insomnia trykker du på schema-knappen for å hente opp dokumentasjonen etter at du har satt opp:

Andre API artikler

• Liste over API-funksjonalitet.
• API paginering.

Testserver

Kontakt support@lucalabs.com om du ønsker tilgang til vår testserver.