Kala's API-dokumentation

Lav dine egne integrationer med Kala vha. vores åbne API

Kala's API


Kala har et åbent API, som gør det muligt at udføre en række handlinger fra eksterne systemer. API’et er en delmængde af det API, som vores egne applikationer bruger. For at opnå adgang til det åbne API, skal man have en API-nøgle.

Hvis du endnu ikke har en API-nøgle, kan du se, hvordan man opretter en her.

API-dokumentation

API-kald laves på adressen https://app.kala.dk/webapiv2/ efterfulgt af et API-kald. Resultatet af et kald returneres altid som JSON.


Index

Index returnerer altid “API READY”.

Index Call

Parametre:

Index Parameters

Returnerer:

Index Returns

Ping

Ping tjekker API-nøglen, og returnerer “pong” hvis nøglen er ok.

Ping Call

Parametre:

Ping Parameters

Returnerer:

Ping Returns

CustomersList

CustomersList returnerer en liste af kunder i Kala-virksomheden.

Listen er sideinddelt, for at undgå for store kald.

CustomersList Call

Parametre:

CustomersList Parameters

Returnerer:

CustomersList Returns

ActiveEmployeesList

ActiveEmployeesList returnerer en sideinddelt liste af aktive medarbejdere.

ActiveEmployeesList Call

Parametre:

ActiveEmployeesList Parameters

Returnerer:

ActiveEmployeesList Returns

ProjectsList

ProjectsList returnerer en sideinddelt liste af sager, som en given medarbejder har adgang til.

ProjectsList Call

Parametre:

ProjectsList Parameters

Returnerer:

ProjectsList Returns

AddHours

AddHours registrerer timer på en sag (og opgave).

AddHours Call

Parametre:

AddHours Parameters

Timer formateres som en decimal-repræsentation.

Her repræsenterer heltallet timer, og decimaltallet minutter som den tilsvarende brøkdel de udgør af en time.

Minut-decimalen kan udregnes således:

AddHours Returns

Eksempel:

AddHours Returns

Returnerer:

AddHours Returns

SetEmployeeSetting

SetEmployeeSetting sætter en indstilling for en given medarbejder.

Hvis indstillingen ikke findes i forvejen, oprettes den.

SetEmployeeSetting Call

Parametre:

SetEmployeeSetting Parameters

Returnerer:

SetEmployeeSetting Returns

GetMessageOfTheDay

GetMessageOfTheDay returnerer dagens besked.

GetMessageOfTheDay Call

Parametre:

GetMessageOfTheDay Parameters

Returnerer:

GetMessageOfTheDay Returns

GetPauseCase

GetPauseCase returnerer sagen, hvorpå der bør registreres pause-timer.

Der returneres null, hvis der ikke findes en pausesag.

GetPauseCase Call

Parametre:

GetPauseCase Parameters

Returnerer:

GetPauseCase Returns

MarkCliDone

MarkCliDone markerer en opgave som færdig.

MarkCliDone Call

Parametre:

MarkCliDone Parameters

Returnerer:

MarkCliDone Returns

CreateCase

CreateCase opretter en ny sag, og returnerer id’et for den nye sag.

CreateCase Call

Parametre:

CreateCase Parameters CreateCase Parameters

Returnerer:

CreateCase Returns

Kala ApS
Ny Banegårdsgade 48, 8000 Aarhus C
71 99 57 97
info@kala.dk