Skip to content

KB REST API — opbygning, login og versioner

API-versioner

Der findes to versioner af KB REST API i drift. Kaldene er de samme — forskellen ligger i, hvordan du logger ind, og hvordan API'et dokumenterer sig selv.

API v2 API v3
Status Den mest udbredte og bedst beskrevne i dag Nyere
Login Kræver en token. Uden token er der ingen adgang Token eller dit eget KeyBalance-login eller din Azure-bruger
Dokumentation Funktionslisten vises ved at åbne base-URL'en Swagger genereres automatisk
Selve kaldene — Identiske med v2

Beskrivelserne på de følgende sider tager udgangspunkt i v2, da det er den, de fleste installationer kører på. Kalder du mod v3, er payload og funktionsnavne de samme — det er kun adgangen, der er mere fleksibel.

Kom i gang: du skal bruge en base-URL og adgang — enten en token eller et brugerlogin. Begge dele oprettes i KeyBalance af jeres KeyBalance-konsulent eller af KeyBalance A/S. Se opsætningen nedenfor.

Opbygning

KB REST API er opbygget af en række funktioner, der kan stilles til rådighed for det enkelte login.

I KeyBalance:

  • findes en liste af mulige funktioner
  • oprettes en gruppe med adgang til at læse, skrive og oprette
  • oprettes en konkret token eller bruger på den gruppe

Adgangen sker derefter med den token. Grundlaget for API'et er altså en URL inklusive en token.

Åbner man en sådan base-URL i en browser, listes de funktioner, der er adgang til:

Eksempel på base-URL

I v3 dokumenterer API'et sig selv gennem en automatisk genereret Swagger-visning, så funktionerne kan ses og prøves af direkte i browseren.

Typer af funktioner

Grundlæggende findes der 2 grupper af funktioner.

CRUD Funktioner

CRUD Funktioner er de grundlæggende CREATE / READ / UPDATE / DELETE KALD. Her er der ofte linket direkte til en tabel, eller en samling af tabeller. Det kan være varer, kunder eller fakturaer. Her understørres GET / PUT / POST / DELETE.

  • Så vil der som minum være mulighed for at læse data.
  • Hvis det giver mening kan de også oprettes eller oprettes.

Læs mere

Andre funktioner

Vi kan i KeyBalance udvikle mere komplicerede fald. Det kan være en funktion til at oprette en kassekladde, en salgsordre eller andre mere komplekse funktioner.

  • Her er det normalt kun muligt at lave et POST kald. Læs mere

Login

Fast token (v2 og v3)

I den simple udgave bruges en fast token, der ikke udløber, som beskrevet ovenfor. Fordelen er, at det giver en fast URL, der direkte kan trækkes ind i det modtagende program — fx Power BI eller Excel.

Token med udløb (v2 og v3)

Det er også muligt at lade token udløbe og i stedet have brugernavn og kodeord. Så bliver flowet:

  1. Login — returnerer en opdateret token
  2. Brug denne token som en del af URL'en ved det konkrete kald

Brugerlogin og Azure (kun v3)

I v3 kan du desuden logge ind med dit eget KeyBalance-brugerlogin eller med din Azure-bruger i stedet for en token. Det er praktisk, når kaldene skal ske på vegne af et menneske frem for en integration — så følger adgangen brugerens egne rettigheder.

Vælg en fast token til rene systemintegrationer, og brugerlogin når det er en navngiven person, der reelt henter data.