---
title: Comment utiliser l'API Checklick
description: Découvrez comment utiliser l'API Checklick pour intégrer les systèmes de votre organisation à Checklick. Suivez le guide de démarrage rapide, familiarisez-vous avec les points de terminaison de l'API, les exigences d'authentification et apprenez à gérer les utilisateurs, les étiquettes et les listes de contrôle grâce à des requêtes RESTful sécurisées et versionnées.
---
[Passer au contenu](https://help.checklick.com/fr/articles/how-do-i-use-the-checklick-api#main-content)
- [Français](https://help.checklick.com/fr/articles/how-do-i-use-the-checklick-api)
- [English](https://help.checklick.com/articles/how-do-i-use-the-checklick-api)
Français
Afficher le sous-menu pour les traductions
[](https://support.checklick.com/migration/migrated/knowledge)
Ouvrir la navigation principale
Fermer la navigation principale
- - [Français](https://help.checklick.com/fr/articles/how-do-i-use-the-checklick-api)
- [English](https://help.checklick.com/articles/how-do-i-use-the-checklick-api)
Français
Afficher le sous-menu pour les traductions
- [Submit a Ticket](mailto:support@checklick.com)
[Submit a Ticket](mailto:support@checklick.com)
Comment pouvons-nous vous aider ?
- Il n'y a aucune suggestion car le champ de recherche est vide.
1. [Help Center (fr)](https://help.checklick.com/fr/articles?hsLang=fr)
2. [L'API Checklick](https://help.checklick.com/fr/articles/lapi-checklick?hsLang=fr)
3. [Utiliser l'API](https://help.checklick.com/fr/articles/lapi-checklick?hsLang=fr#utiliser-lapi)
# Comment utiliser l'API Checklick
Si votre organisation souhaite intégrer ses propres systèmes avec Checklick, vous pouvez utiliser l'API de Checklick. L'API est disponible pour toutes les organisations.
**Démarrage rapide**
Pour commencer rapidement et envoyer une requête de test à Checklick :
1. Connectez-vous à Checklick en tant que gestionnaire de votre organisation.
2. Cliquez sur le menu contextuel de l'utilisateur (en haut à droite).
3. Cliquez sur votre nom.
4. Trouvez la section **Clé secrète de l'API** (API Secret Key) et cliquez sur **générer une nouvelle clé**.
5. Vous devriez maintenant voir une zone de texte avec un exemple de commande cURL. Copiez et collez-la dans votre terminal, puis appuyez sur Entrée.
6. Vous devriez recevoir une réponse JSON contenant la liste de toutes les personnes de votre organisation.
**À propos de l'API**
L'API de Checklick est une API de type RESTful qui renvoie des données au format JSON. L'API respecte la [spécification JSON-API,](https://jsonapi.org/) qui est une norme documentée pour la structure des requêtes et des réponses API.
Chaque gestionnaire dans Checklick est en mesure de générer sa propre clé API secrète (indépendante de son identifiant et de son mot de passe), qu'il peut utiliser pour accéder aux données de Checklick via l'API.
La portée de l'accès aux données d'un utilisateur de l'API sera la même que sa portée d'accès dans l'application web. Un utilisateur de l'API pourra uniquement afficher et modifier les données des personnes faisant partie des organisations qu'il gère, ainsi que des organisations qu'il peut consulter en raison de licences de listes de contrôle.
**Points de terminaison de l'API (Endpoints)**
L'API utilise des URI sans état, basées sur les ressources. Les points de terminaison suivants sont disponibles à partir de [https://api.checklick.com](https://api.checklick.com/) depuis la dernière version de l'API (version 2) :
| **URI** | **Verbe HTTP** | **Description** |
| --- | --- | --- |
| **/users** | GET | Récupérer toutes les personnes visibles pour cette organisation |
| **/users** | POST | Créer une nouvelle personne |
| **/users/1** | GET | Récupérer une personne spécifique |
| **/users/1** | PATCH | Mettre à jour une personne |
| **/users/1/assessments** | GET | Récupérer toutes les évaluations (registres de compétences) pour une personne |
| **/users/1/assessments/1** | GET | Récupérer un registre d'évaluation spécifique pour une personne |
| **/users/1/credentials** | GET | Récupérer tous les registres de certifications pour une personne. **Les registres de certifications sont utilisés pour produire les certificats de réussite de niveau**. |
| **/users/1/credentials/1** | GET | Récupérez le dossier de compétences d'une personne. **Les dossiers de compétences servent à délivrer les certificats de réussite de niveau.** |
| **/users/1/tag-applications** | GET | Récupérer toutes les applications de étiquettes (étiquettes générales) pour une personne |
| **/users/1/tag-applications/1** | GET | Récupérer une application d'étiquette spécifique pour une personne |
| **/users/1/tag-applications** | POST | Appliquer une étiquette existante à une personne |
| **/users/1/tag-applications/1** | DELETE | Retirer une étiquette existante d'une personne |
| **/tags** | GET | Récupérer toutes les étiquettes existantes (créées par votre organisation) |
| **/tags** | POST | Créer une nouvelle étiquette |
| **/tags/1** | GET | Récupérer une étiquette existante |
| **/tags/1** | PATCH | Mettre à jour une étiquette existante |
| **/tags/1** | DELETE | Supprimer une étiquette existante |
| **/tags/1/tag-applications** | GET | Révéler toutes les applications d'étiquettes (étiquettes générales) d'une étiquette spécifique |
| **/tags/1/tag-applications** | PUT | Appliquer une étiquette existante à une personne |
| **/tags/1/tag-applications/1** | GET | Récupérer une application d'étiquette spécifique pour une personne |
| **/tags/1/tag-applications/1** | DELETE | Retirer une étiquette existante d'une personne |
| **/checklists** | GET | Récupérer toutes les listes de contrôle disponibles pour cette organisation |
| **/checklists/1** | GET | Récupérer une liste de contrôle spécifique |
| **/levels** | GET | Récupérer tous les niveaux disponibles pour cette organisation |
| **/levels/1** | GET | Récupérer un niveau spécifique |
| **/levels/1/credentials** | GET | Récupérez toutes les certifications (niveaux atteints) pour ce niveau et attribuées aux personnes visibles par cette organisation. **Ces enregistrements de certifications servent à produire les certificats de réussite de niveau.** |
| **/levels/1/credentials/1** | GET | Récupérez une attestation spécifique. **Les relevés d'attestation servent à produire les certificats de réussite de niveau.** |
| **/sections** | GET | Récupérer toutes les sections disponibles pour cette organisation |
| **/sections/1** | GET | Récupérer une section spécifique |
| **/skills** | GET | Récupérer toutes les compétences disponibles pour cette organisation spécifique |
| **/skills/1** | GET | Récupérer une compétence spécifique |
| **/skills/1/assessments** | GET | Récupérer toutes les évaluations (niveaux de registres de compétences) pour cette compétence et enregistrées pour les personnes visibles par cette organisation |
| **/skills/1/assessments/1** | GET | Récupérer une évaluation spécifique |
Voici un exemple de requête pour le point de terminaison suivant **`/tags` (POST - Créer une nouvelle étiquette) :**
{
"data": {
"type": "tags",
"attributes": {
"name": "NOM DE L'ÉTIQUETTE" }
}
}
**Point de terminaison `/tags/1/tag-applications` (PUT - Appliquer une étiquette existante à une personne) :**
{
"data": {
"type": "tag\_applications",
"attributes": {
"detail": "detail text"
},
"relationships": {
"tag": {
"data": { "type": "tags", "id": 62782 }
},
"user": {
"data": { "type": "users", "id": 161753 }
}
}
}
}
**La description complète de la charge utile :
Quelles sont les exigences minimales pour créer un nouvel utilisateur ?**
Lors de la création d'un nouvel utilisateur, les champs suivants sont obligatoires : nom d'utilisateur, prénom, nom, adresse e-mail, date de naissance, mot de passe, confirmation du mot de passe.
Voici la description complète de la charge utile :
{
"data": {
"type": "users",
"attributes": {
"username": "test user",
"first-name": "testuser",
"last-name": "testuser",
"email": "test@test.com",
"birth-date": "1999-02-19",
"gender": "",
"full-address": "",
"street-address": "",
"city": "",
"province": **null**,
"country": "",
"postal-code": "",
"political": **null**,
"admin-area-2": **null**,
"admin-area-3": **null**,
"admin-area-4": **null**,
"admin-area-5": **null**,
"colloquial-area": **null**,
"ward": null,
"sublocality": **null**,
"neighborhood": **null**,
"premise": **null**,
"subpremise": **null**,
"lat": **null**,
"lng": **null**,
"phone": **null,**
"health-notes": **null**,
"personne-à-contacter-en-urgence": **null**,
"coordonnées-à-contact-en-urgence": **null**,
"mot-de-passe": "1234",
"confirmation-mot-de-passe": "1234"
}
}
}
Exigences de connexion
### Sous-domaine de l'API
Toutes les requêtes doivent être envoyées à **api.**checklick.com. Toute requête API envoyée à *app.checklick.com*, www.checklick.com ou tout autre sous-domaine de Checklick sera refusée.
### HTTPS
Les requêtes envoyées via HTTP seront refusées. Toutes les requêtes doivent être envoyées en utilisant HTTPS.
### En-tête Content-Type
Toutes les requêtes doivent inclure l['en-tête de type de média spécifique au fournisseur JSON](https://jsonapi.org/#mime-types) API. Par exemple :
```
Content-Type:application/vnd.api+json
```
### En-tête de version de l'API
L'API Checklick dispose d'un système de gestion des versions, ce qui signifie que les futures mises à jour de l'API ne casseront pas nécessairement votre implémentation actuelle. La version actuelle de l'API est la version 2. Toutes les requêtes doivent inclure un numéro de version sous forme d'en-tête. Par exemple :
```
Api-Version:2
```
### Clé secrète
Checklick utilise des clés secrètes pour authentifier chaque requête (au lieu d'un identifiant et d'un mot de passe). Chaque gestionnaire d'une organisation peut créer une clé secrète unique. Voici comment générer votre clé :
1. Connectez-vous à Checklick en tant que gestionnaire de votre organisation.
2. Cliquez sur le menu contextuel de l'utilisateur (en haut à droite).
3. Cliquez sur votre nom.
4. Trouvez la section **Clé secrète de l'API** (API Secret Key) et cliquez sur **générer une nouvelle clé**.
Toutes les requêtes doivent inclure une clé secrète valide. Par exemple :
```
Authorization:Token token=2c96ef73e5ad003362b1851cb7c607f3
```
### Identifiant de l'organisation
De nombreux gestionnaires gèrent plus d'une organisation dans Checklick. Comme méthode d'authentification supplémentaire, toutes les requêtes doivent inclure un en-tête spécifiant un identifiant d'organisation qui provient d'une organisation gérée par l'utilisateur dont la clé secrète a été transmise. Par exemple :
```
Organization-Id:999
```
L'identifiant de l'organisation sera utilisé comme « contexte » pour la requête, ce qui signifie que les données que vous recevrez seront limitées aux mêmes données auxquelles vous pouvez accéder lorsque vous gérez cette organisation spécifique.
**Assembler le tout**
Si vous utilisez cURL, votre requête pourrait ressembler à ceci :
```
curl -X GET \
```
https://api.checklick.com/users\\
-H 'Api-Version: 2' \\
-H 'Authorization: Token token=2c96ef73e5ad003362b1851cb7c607f3' \\
-H 'Content-Type: application/vnd.api+json' \\
-H 'Organization-Id: 999'
**Pagination, recherche et filtrage**
### Pagination
Les résultats contenant plus de 10 éléments seront automatiquement paginés. Vous verrez des liens au bas de vos résultats vers la première, la suivante et la dernière page. Par exemple :
JSON
```
"links": {
```
"first": "https://api.checklick.com/users?page%5Bnumber%5D=1&page%5Bsize%5D=10",
"last": "https://api.checklick.com/users?page%5Bnumber%5D=1&page%5Bsize%5D=10"
}
### Recherche ou filtrage
Lorsque vous accédez à des points de terminaison qui renvoient plusieurs éléments, vous pouvez inclure un paramètre de filtre pour limiter le nombre d'éléments affichés. Ces paramètres doivent être inclus dans votre requête en tant que **paramètres de requête**.
La plupart des attributus peuvent être utilisés comme paramètres. Par exemple, pour filtrer toutes vos personnes par un nom de famille spécifique, essayez :
```
https://api.checklick.com/users?filter[last_name]=Smith
```
Vous pouvez également appliquer deux filtres spéciaux, created\_on\_or\_after et created\_before, pour afficher uniquement les enregistrements créés à une date et une heure spécifiques, après ou avant. Le paramètre de ce filtre est un horodatage UNIX. Par exemple, pour obtenir tous les utilisateurs créés après le 1er janvier 2018, essayez :
```
https://api.checklick.com/users/?filter[created_on_or_after]=1514764800
```
Vous pouvez facilement convertir des dates en horodatages UNIX grâce à cette [page](https://www.unixtimestamp.com/index.php).
- [Aide pour les personnes disposant d’un compte Checklick](https://help.checklick.com/fr/articles/aide-pour-les-personnes-disposant-dun-compte-checklick?hsLang=fr#main-content)
- [Votre profil](https://help.checklick.com/fr/articles/aide-pour-les-personnes-disposant-dun-compte-checklick?hsLang=fr#votre-profil)
- [Aide pour les vitrines Checklick](https://help.checklick.com/fr/articles/aide-pour-les-vitrines-checklick?hsLang=fr#main-content)
- [Bien démarrer avec la boutique Checklick](https://help.checklick.com/fr/articles/aide-pour-les-vitrines-checklick?hsLang=fr#bien-d%C3%A9marrer-avec-la-boutique-checklick)
- [Gérer votre vitrine](https://help.checklick.com/fr/articles/aide-pour-les-vitrines-checklick?hsLang=fr#g%C3%A9rer-votre-vitrine)
- [Aide aux évaluateurs et aux gestionnaires](https://help.checklick.com/fr/articles/aide-aux-%C3%A9valuateurs-et-aux-gestionnaires?hsLang=fr#main-content)
- [Bien démarrer](https://help.checklick.com/fr/articles/aide-aux-%C3%A9valuateurs-et-aux-gestionnaires?hsLang=fr#bien-d%C3%A9marrer)
- [Utiliser des listes de contrôle](https://help.checklick.com/fr/articles/aide-aux-%C3%A9valuateurs-et-aux-gestionnaires?hsLang=fr#utiliser-des-listes-de-contr%C3%B4le)
- [Gérer vos collaborateurs](https://help.checklick.com/fr/articles/aide-aux-%C3%A9valuateurs-et-aux-gestionnaires?hsLang=fr#g%C3%A9rer-vos-collaborateurs)
- [Créer vos propres listes de contrôle](https://help.checklick.com/fr/articles/aide-aux-%C3%A9valuateurs-et-aux-gestionnaires?hsLang=fr#cr%C3%A9er-vos-propres-listes-de-contr%C3%B4le)
- [Plans de paiement et facturation](https://help.checklick.com/fr/articles/aide-aux-%C3%A9valuateurs-et-aux-gestionnaires?hsLang=fr#plans-de-paiement-et-facturation)
- [Licence de liste de contrôle (Partage de vos listes de contrôle avec d'autres organisations)](https://help.checklick.com/fr/articles/aide-aux-%C3%A9valuateurs-et-aux-gestionnaires?hsLang=fr#licence-de-liste-de-contr%C3%B4le-partage-de-vos-listes-de-contr%C3%B4le-avec-dautres-organisations)
- [Connaissances](https://help.checklick.com/fr/articles/aide-aux-%C3%A9valuateurs-et-aux-gestionnaires?hsLang=fr#connaissances)
- [Comptes Stripe](https://help.checklick.com/fr/articles/comptes-stripe?hsLang=fr)
- [L'API Checklick](https://help.checklick.com/fr/articles/lapi-checklick?hsLang=fr#main-content)
- [Utiliser l'API](https://help.checklick.com/fr/articles/lapi-checklick?hsLang=fr#utiliser-lapi)
[](https://www.checklick.com/)
Checklick is a web-based platform for skill development.
It helps generate checklists that are being used to test
people’s abilities and provide feedback.
[mailto:support@checklick.com](mailto:support@checklick.com)
Copyright © 2025, Checklick