Qu'est-ce que REST?

REST - Representational State Transfer est un modèle architectural qui décrit comment les systèmes distribués peuvent communiquer avec une interface et représentation des données cohérentes. En gros, cela signifie que « ne fait rien jusqu'à ce qu'on le lui demande, et ne t'inquiète pas du fait que l'API soit au repos entre-temps. »

Les API REST sont accessibles au moyen du protocole HTTPS, par l'intermédiaire d'un ensemble prédéfini d'URI connus sous le nom de « points de terminaison. »

 /employees

Les points de terminaison peuvent avoir des actions pour les processus d'entreprise et les flux de travail :

/employees/id/actions/force-password-change

Les points de terminaison de l'API reçoivent des appels pour fournir, échanger ou capturer de l'information par des méthodes telles que :

GET - Obtenir de l'information du système.

POST - Envoi d'information au système, généralement pour créer de nouveaux enregistrements ou déclencher un processus ou flux de travail.

PATCH - Envoi d'information au système, généralement pour mettre à jour des enregistrements existants.

Toutes les méthodes d'appel aboutissent généralement à une RÉPONSE qui vous est renvoyée pour vous communiquer les résultats.

Format de données JSON

L'API TrackTik s'attend à travailler avec de l'information formatée en JavaScript Object Notation. Il s'agit d'un format clé:valeur hiérarchique.

[GET] /employees/322
{ 
     "id" : 322,
     "name" : "My Name",
     "email" : "myemail@domain.ca",
     "startDate" : "2010-01-01"
}

Anatomie d'un appel API

« Je veux voir les données d'une inscription d'employé dont l'identifiant unique est 322 ».

Les outils du métier

Vous pouvez accéder à l'API TrackTik à partir de votre langage de programmation préféré, d'un logiciel d'échange de données électroniques (comme Postman), de JavaScript et même d'une macro VBA dans Excel.

Par exemple

Authentification PHP - Curl

<?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_POSTFIELDS, array(
        'client_id'     => "d6543c...",
        'client_secret' => "bdc6ed2e...",
        'username'      => "developer@domain.com",
        'password'      => "secret",
        'grant_type'    => 'password'
 ));

 $data = curl_exec($ch);
 $auth_string = json_decode($data, true);
 print_r($auth_string);
?>

Postman - Recherche de modèles de rapports