API v1 (Timesheet Pro)

Inhoudsopgave

Read
    - Voorbeeldcode in PHP: readAll/invoice
    - myData
    - readAll
    - readSingle

Read

Bij het opvragen van data is het van belang dat je de vorige hoofdstukken hebt gelezen en weet hoe je connectie kunt maken met de API. Hieronder zal per functie een opsomming worden gemaakt van de datavelden en wat je hier precies bij kunt verwachten als je data uit Timesheet Pro haalt.

Voorbeeldcode in PHP: readAll/invoice

Code:

function curlPost($url, $postData)
{
$ch = curl_init();

curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($postData));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$server_output = curl_exec($ch);
curl_close ($ch);

return $server_output;
}


$url = "https://timesheet.timetick.nl/pro/api/readAll/invoice";
$postData = array(
"api_user" => "user",
"api_pass" => "pass"
);
echo "
";
echo print_r(json_decode(curlPost($url, $postData),true));
echo "
";

myData

De functie myData is bedoeld om je eigen bedrijfsgegevens op te halen uit Timesheet Pro. Zoals eerder gezegd is de basis-URL: https://timesheet.timetick.nl/pro/api/. Om deze functie te kunnen gebruiken, voeg je simpelweg myData toe aan de URL, als volgt: https://timesheet.timetick.nl/pro/api/myData

Net als bij het maken van een testconnectie, ben je verplicht de inloggegevens mee te sturen. Ten opzichte van de testConnection verander je dus alleen de URL:

POST-data:

Naam Waarde Verplicht
api_user De waarde uit beheerdersaccount Ja
api_pass De waarde uit beheerdersaccount Ja


Output:

Zoals eerder gezegd, is de output JSON-encoded. Bij het decoden van de output naar een object of naar een array, kun je de volgende datavelden verwachten:

Veldnaam Datatype Omschrijving
companyname string Bedrijfsnaam
street string Straatnaam
street_number string Huisnummer
postal_code string Postcode
city string Plaats/stad
country string Landcode
email string Regulier e-mailadres
administrativeEmail string Administratief e-mailadres
telephone string Telefoonnummer
fax string Faxnummer
bank string Naam van de bank
iban string IBAN-nummer
iban_name string Tenaamstelling van het IBAN-nummer
coc string Kamer van Koophandel nummer
vat string Btw-nummer

 

readAll

De functie readAll is bedoeld om alle beschikbare gegevens van een bepaald soort tegelijk op te vragen. Zoals eerder gezegd is de basis-URL: https://timesheet.timetick.nl/pro/api/. Om deze functie te kunnen gebruiken, voeg je simpelweg readAll toe aan de URL, als volgt: https://timesheet.timetick.nl/pro/api/readAll

In de URL hierboven hebben we nog niet aangegeven welke data we precies willen hebben. Dat doen we simpelweg door de URL verder aan te passen en één van de volgende mappen erachter te plaatsen:

URL Omschrijving Datavelden
https://timesheet.timetick.nl/pro/api/readAll/customer Een lijst met alle klanten incl. NAW-gegevens Meer informatie »
https://timesheet.timetick.nl/pro/api/readAll/project Een lijst met projecten en bijbehorende informatie Meer informatie »
https://timesheet.timetick.nl/pro/api/readAll/user Een lijst met alle medewerkers Meer informatie »
https://timesheet.timetick.nl/pro/api/readAll/product Een lijst met alle producten Meer informatie »

readSingle

Met readSingle is het mogelijk om een enkel record uit te lezen. Dit kan uiteraard pas wanneer je lokaal een ID hebt opgeslagen waarmee je direct het juiste record kunt selecteren. De id van de record die je wilt lezen, plaats je dan in de URL. Bijvoorbeeld customer/45

URL Omschrijving Datavelden
https://timesheet.timetick.nl/pro/api/readSingle/customer/[id] Klantgegevens Meer informatie »
https://timesheet.timetick.nl/pro/api/readSingle/project/[id] Projectgegevens Meer informatie »
https://timesheet.timetick.nl/pro/api/readSingle/user/[id] Medewerkergegevens Meer informatie »
https://timesheet.timetick.nl/pro/api/readSingle/product/[id] Productgegevens Meer informatie »


Reacties

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