Co je API?
API (zkratka pro Application Programming Interface) označuje v informatice rozhraní pro programování aplikací. Tento termín používá softwarové inženýrství.API implementované v docházkovém systému Frekr je funkcionalita, která Vám umožní pracovat s daty nasbíranými pomocí Frekru v jiných aplikacích/systémech. Pomocí API poté můžete bezpečně propojit Frekr třeba s Vašim informačním systémem, systémem pro správu mezd, systémem pro vyřizování zákaznických požadavků a pod.
Následující návod vyžaduje více než jen uživatelskou znalost IT, takže doporučujeme přenechat vašemu správci IT, nebo se můžete obrátit na nás přes e-mail podpora@frekr.me.
Zapnutí API na frekr.me
Než začnete API Frekru používat, tak si musíte vygenerovat API klíč. Tento klíč uschovejte v bezpečí! Prozrazení klíče může způsobit, že se k Vašim datům dostane někdo nepovolaný. |
| Vygenerování API klíče v administraci Frekr. |
Následně se zobrazí váš API klíč. Tento klíč není možné zobrazit znovu. Při ztrátě je možné vygenerovat nový.
 |
| Zobrazení API klíče v administraci Frekr. |
Dokumentace k API
Dokumentace k funkcím dostupných v rámci našeho API je k nahlédnutí na adrese na https://frekr.me/api/doc/v1, kde také můžete API vyzkoušet v testovacím poli (Sandboxu). |
| Otevření Sandboxu. |
Příklad získání dat z API
Pokud budete chtít např. zobrazit všechny uživatele, kteří jsou zrovna v práci, tak můžete takto. |
| Použití Sandboxu. |
Pokud rádi pracujete v příkazové řádce, tak můžete API načítat takto jednoduše:
curl -H 'apikey: 51bCx404LrsNxSZdR9akEC9H9HbcER6kfUya3OVZNDU2OTc4' https://frekr.me/api/v1/employees?working=true | python -m json.tool
Ukázka integrace s jinou aplikací (SupportBox.cz)
Propojení aplikace Frek a systému pro správu klientských požadavků SupportBox jako ukázka využití API v praxi. Do systému takto můžete jednoduše integrovat informace o aktuálně pracujících, které se získají v reálném čase z aplikace Frekr. Při práci na požadavcích tak okamžitě vidíte, komu můžete zprávu od zákazníka delegovat, protože je zrovna přítomen v práci.Nápověda k nastavení SupportBox je k dispozici na https://supportbox.cz/univerzalni-plugin/
 |
| Integrace Frekr a SupportBox. |
Použitý skript:
<?php
$frekr_key = 'apikey: 51bCx404LrsNxSZdR9akEC9H9HbcER6kfUya3OVZNDU2OTc4'; // Sem vložte klíč z nastavení na Frekr.me
$sb_key = '02993b7d69cd6da1152356262c022644'; // Sem vložte klíč z nastavení pluginu na SupportBox.cz
// Ověření bezpečnosti
if ($_GET["key"] != $sb_key) {
echo "Neoprávněný přístup";
die;
}
// Zde můžete psát váš kód, který se zobrazí v pravém sloupci v SupportBoxu
$ch = curl_init();
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_URL, 'https://frekr.me/api/v1/employees?working=true');
curl_setopt($ch, CURLOPT_HTTPHEADER, array($frekr_key));
$result = curl_exec($ch);
curl_close($ch);
$data = json_decode($result);
$response = "";
foreach ($data->data as $d) {
$response.= $d->attributes->lastname . ' ' . $d->attributes->firstname . '<br>';
}
echo json_encode(['html' => $response]);
?>
Pokud by vás zajímaly další možnosti a případy pro konkrétní využití API Frekru ve vašich systémech, kontaktujte nás na podpora@frekr.me.
