API v1 (Timesheet Pro)

Inhoudsopgave

Hoe werkt de API?
    - readAll
    - readSingle
    - update
    - create

Hoe werkt de API?

TimeTick Timesheet beschikt over een uitgebreide API met Create, Read en Update mogelijkheden. Deze API is eenvoudig over HTTPS te bereiken en is eenvoudig te implementeren in bestaande software, door middel van cURL of een andere library die in staat is POST requests naar URL's te versturen. Alle data die wordt ontvangen bij een leesoperatie wordt in JSON-formaat aangeboden. Voor het inschieten van wijzigingen aan bestaande gegevens, zal de data ook in JSON-formaat moeten worden aangeleverd.

De API heeft geen verschillende machtigingsniveaus. Dat betekent dat wanneer er toegang is tot de API via een bepaalde account, alle informatie (die ondersteund wordt door de API) kan worden uitgelezen, gewijzigd en toegevoegd.

De API bestaat uit 4 basisfuncties, te weten:

  1. readAll
  2. readSingle
  3. update
  4. create

Verderop in deze documentatie wordt nader toegelicht hoe deze functies werken en hoe je ze kunt gebruiken om de gewenste informatie boven water te krijgen. Voor nu is het alleen belangrijk om te weten wat elke functie globaal doet.

readAll

De readAll functie is bedoeld om een volledige dataset tegelijk op te halen. Wanneer bijvoorbeeld een maatwerk applicatie moet worden voorzien van alle klanten van uw bedrijf, kan de readAll functie deze dataset aanbieden.

readSingle

De readSingle functie is bedoeld om snel en eenvoudig een enkel record uit de database te halen en te bekijken. Wanneer u bijvoorbeeld de gegevens van een bepaalde debiteur op wilt halen, kan dat met deze functie, zonder dat de volledige dataset opgehaald hoeft te worden.

update

Met de update functie kunnen bijvoorbeeld bepaalde details van een project worden bijgewerkt. Het is daarbij niet mogelijk om met één update commando, direct meerdere records te updaten. Uiteraard kunnen er wel meerdere requests achter elkaar worden uitgevoerd.

create

Het create-commando, is bedoeld om nieuwe records in de database aan te maken. Wanneer bijvoorbeeld een klant in uw webshop zich aanmeldt, kan deze direct als debiteur toegevoegd worden in TimeTick Timesheet. Evenals het update-commando, is het niet mogelijk om meerdere creates tegelijk uit te voeren, maar wel in successie.



Reacties

Er zijn nog geen reacties.
 Meld je aan met LinkedIn om te reageren