Skip to content

API LæseAPI

KB API er en fast struktur til at hente data ud af KeyBalance.

Selve metoden er fast, men de tabeller og kolonner der hentes, kan nemt ændres i via programmering i KB.

I de fleste opsætninger køres http (ikke https) og med fast token. Begge dele kan fra december 2020 versionen konfigureres.

Struktur

Data hentes som JSON-struktur ud fra en url, der inkluderer server/system/login og den konkrete tabel. Der hentes via en http GET.

Retur er en række ”rows” i JSON, hvor kolonnerne per "row" afhænger af den konkrete tabel.

Elementet ”ID” skal bruges ved fremtidig opdatering af denne record, eller ved page_next. Ofte hentes blot den fulde mængde.

Liste eller enkelte records

De angivne URL’er henter et ARRAY, en liste over records. Ved at inkludere det konkrete ID kan der hentes enkelte poster. Altså / på den generelle URL.

Som ID kan anvendes enten ’id’ værdien fra en liste ( "id": ["000000007533"] ) , eller selve værdien af den primære nøgle, fx kunde eller varenr 000000007533.

I en snarlig version vil vi også inkludere den direkte URL i objektet.

Eksempel

https://test_api.kbcloud.dk/KB/api2/50229EA9-A883-45DD-A19F-D7ACCACB1891/Debitorer?Size=2

og

https://test_api.kbcloud.dk/KB/api2/50229EA9-A883-45DD-A19F-D7ACCACB1891/Debitorer/000000007533

https://test_api.kbcloud.dk/KB/api2/50229EA9-A883-45DD-A19F-D7ACCACB1891/Debitorer/[%22000000007533%22]

Retursvaret fra liste og enkelt record er principielt ens, dog hentes listen som et array og den enkelte post som et object. Dette object er lig det, som skal sendes ved data-skrivninger.

Argumenter i URL (kun relevant ved GET)

  • Antal records i retur Size= Size= 5

  • Mulighed for at søge i feed, (kan tage noget tid) Search=

Search er et “filterby” array, en liste over felter og deres værdi.

Der kan anvendes interval, fx ”01.01.2017..” for 01/01/2017 og frem.

search={"filterby":[

{"PostNr":"2720"}

]}

  • Sortering Sort= Sort=Navn

  • Hent kun records AFTER et givent id After= After= ["+014802065649"] (encoded)

  • For at ramme en ENKELT record kan ID tilføjes direkte i slutningen af url’en, fx:

https://test_api.kbcloud.dk/KB/api2/50229EA9-A883-45DD-A19F-D7ACCACB1891/Debitorer/000000007533

  • Eksempel på søgning. Salgslinjer for debitor 88887830
  • Eller Varenummer 23

https://test_api.kbcloud.dk/KB/api2/50229EA9-A883-45DD-A19F-D7ACCACB1891/Fakturalinjer?search={"filterby":[{"DKontonr":"000000007533"}]}

https://test_api.kbcloud.dk/KB/api2/50229EA9-A883-45DD-A19F-D7ACCACB1891/Fakturalinjer?search={"filterby":[{"VNummer":"23"}]}