Pour commencer
L'API de TrackTik est proposée sous la forme d'un service basé sur le nuage mensuel payant, mais des accords de partenariat réciproques sans coût supplémentaire sont également disponibles. Une fois l'accès obtenu, l'utilisation de l'API n'est pas limitée, sauf par certains plafonds techniques définis pour protéger votre expérience et la disponibilité du service.
Pour demander l'accès, vous devez communiquer avec votre responsable du succès des clients de TrackTik, qui vous aidera à prendre les dispositions nécessaires. Cela vous conduira à une consultation rapide avec notre Équipe des relations avec les développeurs sur le niveau d'accès dont vous avez besoin, et un compte de service API sera créé pour vous afin que vous puissiez commencer à innover et à intégrer.
Si vous n'êtes pas encore client de TrackTik par le biais de ses applications Suite d'opérations de gardiennage, TTSHIFT ou Ronde de garde et que vous souhaitez le devenir, vous pouvez utiliser notre page Communiquez avec nous pour commencer.
Compte de service API
Un compte de service API TrackTik est un ensemble d'information d'identification pour l'authentification et les autorisations de rôle pour le contrôle d'accès aux données que vous avez l'intention de récupérer ou de créer au sein de l'écosystème TrackTik. Elles sont divisées comme suit : les éléments en vert et en gras sont les données que vous utiliserez lors de l'authentification et de l'obtention d'un jeton d'accès).
Références et champ d'application d'OAuth 2
- Identifiant du client
- Secret du client
- Le champ d'application est configuré pour vous dans une inscription client (définit les points de terminaison et les actions de l'API qui sont disponibles).
- Une URL pour demander des jetons d'accès
Dossier de l'employé, rôle et autorisations
- Une inscription d'employé est créée avec le nom d'utilisateur et le mot de passe générés.
- Un rôle est attribué à l'employé
- Le rôle se voit attribuer des autorisations
N.b. : Le champ d'application OAuth 2 et le rôle/les autorisations de l'employé seront mis en correspondance afin que les entités, leurs actions et tous leurs contextes de données dont vous avez besoin soient mis à disposition. Cela permet de protéger l'intégrité de vos données de production et d'empêcher l'escalade des autorisations en cas de compromission de votre API ou de l'information d'identification de l'employé.
Authentification (obtention d'un jeton d'accès JWT au moyen du flux de mots de passe OAuth 2)
N.b. : Ne fournissez pas de valeurs pour « portée » puisque nous aurons déjà configuré cela en interne au moyen d'une inscription client OAuth 2.
Authentification (exemple PHP au moyen d'OAuth 2 Password Flow)
<?php
$portal = 'https://<domain>/rest/oauth2/access_token';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $portal);
curl_setopt($ch, CURLOPT_POST, TRUE);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_POSTFIELDS, array(
'client_id' => "d6543cb8...",
'client_secret' => "bdc6ed2e...",
'username' => "username",
'password' => "smart password that isn't 12345",
'grant_type' => 'password'
));
$data = curl_exec($ch);
$auth_string = json_decode($data, true);
$access_token = $auth_string["access_token"];
$refresh_token = $auth_string["refresh_token"];
curl_close($ch);
?>