API - Track History

1. Présentation

Notre API est destinée à un usage purement professionnel, elle permet la communication en S2S (server-to-server) entre votre serveur et le serveur de Track History.

Le principal avantage de l'API est l'automatisation de vos évènements. Si vous possédez un site ou une plateforme qui effectue des transactions en temps réel, vous n'allez bien sûr pas rester derrière pour reporter chaque transaction à la main sur votre compte Track History.

En outre, l'API vous permet aussi de :

Lister vos évènements
Gérer vos groupes
Gérer vos catégories
Gérer vos types de valeurs

2. Prérequis

Posséder un serveur capable d'envoyer des requêtes HTTP
Acheter des requêtes API sur Track History
Avoir quelques connaissances techniques ou embaucher un développeur *

* En l'absence de développeur, nous pouvons nous occuper de l'installation si votre infrastructure nous le permet. Ceci est toutefois un service payant.

3. Étapes pour obtenir une clef privée

Créer un compte sur Track History
Acheter des requêtes API
Rendez-vous sur Mes comptes API
Assurez-vous d'avoir au moins un compte Actif
Copiez la clef privée

La clef privée n'est affichée que partiellement sur l'interface ! Cliquez dessus vous permettra de la copier intégralement.

Attention ! Une clef privée doit être uniquement utilisé côté backend. Ne l'utilisez pas sur du frontend (html, js, ou tout code pouvant être lu directement sur le navigateur).

N'utilisez l'API que si vous savez exactement ce que vous faites, c'est un risque de sécurité potentiel pour votre compte Track History.

4. Comment utiliser la clef dans vos requêtes

Vous pouvez utiliser votre clef privée soit dans les headers de votre requête en Bearer, soit dans les paramètres de requête.

Dans les exemples ci-dessous, remplacez <code>votre_clef_privee</code> par la clef privée que vous aviez copiée.

1. Bearer token

curl -i https://api.track-history.com \
"Authorization: Bearer votre_clef_privee"

2. Paramètre de requête

https://api.track-history.com?token=votre_clef_privee

5. Requêtes

URL d'accès à l'API : https://api.track-history.com

Les paramètres envoyés et les réponses sont toujours en JSON

Content-Type: application/json

> Groupe

Nom	Route	Paramètres / Réponse
Liste des groupes	`GET /event-group`	Réponse `[ { "id": 1, "name": "Dépenses", "description": "Analyser les sommes utilisées chaque mois", "photo": { "slug": "TeUqxthri2qlUKx7", "path": "event-group/photo/2024/03/29/TeUqxthri2qlUKx7.png", "size": 0.1 }, "defaultValues": [ { "eventGroupId": 1, "eventValueTypeId": 1, "value": 10 } ] } ]`
Compter les groupes	`GET /event-group/count`	Réponse `1`
Récupérer un groupe	`GET /event-group/{id}`	Réponse `{ "id": 1, "name": "Dépenses", "description": "Analyser les sommes utilisées chaque mois", "photo": {...}, "defaultValues": [...] }`
Créer un groupe	`POST /event-group`	Paramètres `{ "name": "Dépenses", "description": "Analyser les sommes utilisées chaque mois", "photo": { "data": "base64encodedfile", "extension": "png" }, "defaultValues": [...] }` Réponse (ID du groupe créé) `1`
Mettre à jour un groupe	`PATCH /event-group/{id}`	Paramètres - Same as POST
Supprimer un groupe	`DELETE /event-group/{id}`	Pas de réponse

> Catégorie

Nom	Route	Paramètres / Réponse
Liste des catégories	`GET /event-type`	Réponse `[ { "id": 32, "eventGroupId": 1, "name": "Loyer", "description": "850€/Mois", "photo": {...}, "defaultValues": [...] } ]`
Récupérer une catégorie	`GET /event-type/{id}`	Réponse - Single category object
Créer une catégorie	`POST /event-type`	Paramètres `{ "eventGroupId": 1, "name": "Loyer", "description": "850€/Mois", "photo": {...}, "defaultValues": [...] }` Réponse (ID de la catégorie créée) `32`
Mettre à jour une catégorie	`PATCH /event-type/{id}`	Paramètres - Same as POST
Supprimer une catégorie	`DELETE /event-type/{id}`	Pas de réponse

> Type de valeur

Nom	Route	Paramètres / Réponse
Liste des types de valeurs	`GET /event-value-type`	Réponse `[ { "id": 24, "name": "Montant", "symbol": "€", "criticalMin": 0, "criticalMax": 1000 } ]`
Récupérer un type de valeur	`GET /event-value-type/{id}`	Réponse - Single value type object
Créer un type de valeur	`POST /event-value-type`	Paramètres `{ "name": "Montant", "symbol": "€", "criticalMin": 0, "criticalMax": 1000 }` Réponse (ID du type de valeur créé) `24`
Mettre à jour un type de valeur	`PATCH /event-value-type/{id}`	Paramètres - Same as POST
Supprimer un type de valeur	`DELETE /event-value-type/{id}`	Pas de réponse

> Évènement

Nom	Route	Paramètres / Réponse
Liste des évènements	`GET /event`	Réponse `[ { "id": 2356, "eventGroupId": 1, "eventTypeId": 32, "name": "Loyer de juillet", "description": "Le propriétaire a encore augmenté les prix", "status": "normal", "selfFulfilled": false, "photo": {...}, "trackingStartingDate": "2024-05-01 00:00:00", "trackingEndingDate": "2024-05-15 23:59:59", "notificationDate": null, "updateDate": "2024-05-01 12:27:54", "values": [...] } ]`
Récupérer un évènement	`GET /event/{id}`	Réponse - Single event object
Créer un évènement	`POST /event`	Paramètres `{ "eventGroupId": 1, "eventTypeId": 32, "name": "Loyer de juillet", "description": "...", "status": "normal", "selfFulfilled": false, "photo": {...}, "trackingStartingDate": "...", "trackingEndingDate": "...", "values": [...] }` Réponse (ID du type de l'évènement créé) `2356`
Mettre à jour un évènement	`PATCH /event/{id}`	Paramètres - Same as POST
Supprimer un évènement	`DELETE /event/{id}`	Pas de réponse

Documentation API