Pour utiliser l'API TimeTonic, vous devez obtenir une clé API nommée Sesskey (session key) qui devra être transmise à chaque requête.
Vous pouvez obtenir une clé API (Sesskey) de deux manières :
- Soit directement via votre Profil utilisateur
- Soit via le site dédié à l'API
Notez qu'une clé API (Sesskey) est toujours liée à un compte utilisateur même si vous utilisez la seconde méthode. C'est pourquoi nous conseillons d'utiliser un compte dédié pour les accès API, généralement un compte du type api_<nomDuClient>
⚠️ Une clé API (Sesskey) peut expirer. Chaque utilisateur, via l'option "Déconnecter vos autres sessions" de son profil, peut choisir de supprimer toutes les autres sessions en cours ce qui détruira l'ensemble des sessions, web, mobiles et API. Pour des raisons de sécurité, TimeTonic se réserve également le droit de supprimer des sessions sans préavis. Les sessions Web ont systématiquement une durée de vie limitée à quelques semaines. |
1. Création d'une clé API (Sesskey) via votre profil utilisateur
La façon la plus simple de créer une clé API (Sesskey) est d'accéder à votre profil utilisateur dans TimeTonic et de cliquer sur le bouton "Generate" de l'option "Clé API (Sesskey)".
Votre profil est facilement disponible à partir du menu d'accueil de TimeTonic et également à l'url suivante : https://timetonic.com/live/v7/account#settings
Une fois votre clé API (Sesskey) générée, copiez-la simplement pour l'utiliser dans vos requêtes via l'API.
2. Création d'une clé API (Sesskey) via le site dédié de l'API
Il est possible que vous ayez besoin de générer plusieurs clés API (Sesskey).
Pour générer une clé API (Sesskey) via le site dédié, il faut suivre plusieurs étapes, dans l'ordre.
Pensez à bien noter vos identifiants car ils ne seront générés qu'une seule fois. Si vous perdez un identifiant, il faudra tout régénérer depuis le début.
Trois étapes sont nécessaires pour la création d'une clé API (Sesskey) par cette méthode : 1) la création d'une Appkey, 2) la création d'une Oauthkey, puis 3) la création de la Sesskey.
2.a. Création de l'Appkey
Depuis le site dédié à l'API, dans createAppkey, choisissez un nom pour voter application en complétant le champ "appname", puis cliquez sur Submit :
Notez-bien les valeurs qui vous sont données :
{ "status": "ok", "appkey": "BsqZ-CvAm-gtRv-GU4h-8zvu-0", "id": "6460", "createdVNB": "dev-4.59b", "req": "createAppkey" }
2.b. Création de l'Oauthkey
Depuis l'API, Dans createOauthkey, renseignez les champs dans l'encadré rouge de la façon suivante :
- login : votre nom de membre TimeTonic
- pwd : votre mot de passe TimeTonic
- appkey : le code correspondant à
"appkey":
, que vous avez récupéré en créant l'Appkey précédemment.
Cliquez ensuite sur Submit :
Notez-bien les valeurs qui vous sont données :
{
"status": "ok", "oauthkey": "xSDA-Qz8J-Bb6f-4zkf-8C3N-0", "id": "6286", "o_u": "demo", "createdVNB": "dev-4.59b", "req": "createOauthkey"
}
2.c. Création de la Sesskey
Depuis le site dédié à l'API, Dans createSesskey, renseignez les champs dans l'encadré rouge de la façon suivante :
- oauth_user (o_u) : votre identifiant TimeTonic
- oauthkey : le code correspondant à
"oauthkey":
, que vous avez récupéré en créant l'Oauthkey précédemment.
Cliquez ensuite sur Submit :
Notez-bien les valeurs qui vous sont données, dont la Sesskey :
{
"status": "ok", "sesskey": "FeI7-2PgX-5fZY-lGRC-MCj4-0", "id": "6436", "createdVNB": "dev-4.59b", "req": "createSesskey"
}