Vue d’ensemble
Un utilisateur API correspond à un ensemble d’identifiants qu’un opérateur utilise pour s’authentifier auprès de l’API Uptrends. Les utilisateurs API sont distincts des identifiants de connexion Uptrends d’un opérateur, ce qui vous permet de les utiliser dans des scripts, des intégrations et des automatisations sans exposer les mots de passe du compte.
Chaque opérateur peut avoir plusieurs utilisateurs API, chacun avec son propre nom d’utilisateur, son mot de passe et son type d’accès. Le type d’accès identifie le client ou l’application qui utilise les identifiants. Par exemple, Generic pour les scripts et l’automatisation, MobileApp pour l’application mobile Uptrends, ou TransactionRecorder pour Uptrends Transaction Recorder.
Cas d’utilisation
- Gérer les identifiants API d’un opérateur — créez, mettez à jour et supprimez des utilisateurs API, y compris le nom d’utilisateur, le mot de passe et le type d’accès API, par programmation.
- Récupérer les détails des utilisateurs API pour suivre l’activité API et contrôler l’accès — gérez les informations d’utilisation, par exemple la date de dernière utilisation des identifiants ou le nombre de requêtes effectuées au cours des 30 derniers jours.
Prérequis
Avant d’utiliser la ApiUser API, assurez-vous de disposer des éléments suivants :
Endpoints de la ApiUser API
La ApiUser API expose les endpoints suivants pour gérer les informations API :
| Méthode | Endpoint | Description |
|---|---|---|
GET |
/ApiUser |
Renvoie une liste de tous les utilisateurs API du compte. |
POST |
/ApiUser |
Crée un nouvel utilisateur API pour un opérateur. Dans le corps de la requête, fournissez uniquement OperatorGuid et Description. Tous les autres champs sont en lecture seule ou attribués par l’API. |
GET |
/ApiUser/Operator/{operatorGuid} |
Renvoie une liste des utilisateurs API de l’opérateur spécifié. |
GET |
/ApiUser/{apiUserGuid} |
Renvoie les détails de l’utilisateur API spécifié, y compris le GUID de l’opérateur, le nom d’utilisateur, le type d’accès et la date de dernière utilisation. |
PUT |
/ApiUser/{apiUserGuid} |
Met à jour l’utilisateur API spécifié. Dans le corps de la requête, fournissez uniquement OperatorGuid et Description. Seul Description peut être mis à jour. Le OperatorGuid associé à l’utilisateur API doit rester inchangé. |
DELETE |
/ApiUser/{apiUserGuid} |
Supprime l’utilisateur API spécifié. |
Pour obtenir les formats détaillés des requêtes et des réponses, ainsi que pour tester l’API de manière interactive, consultez la documentation de la ApiUser API Uptrends.
Exemples de la ApiUser API
Réponse GET
Exemple de réponse pour GET /ApiUser :
[
{
"ApiUserGuid": "c1534087-590e-497e-b58e-00bc4dbfa1d3",
"OperatorGuid": "ab12345c-0d8e-46a2-acef-dd1e15571097",
"UserName": "c1534087590e497eb58e00bc4dbfa1d3",
"Type": "Generic",
"Description": "Transaction Recorder",
"CreatedDate": "2025-11-11T21:18:01",
"LastUsed": "25/06/2026 19:37:59",
"UsageLast30Days": 17706
}
]
GET /ApiUser/{apiUserGuid} renvoie un objet unique avec les mêmes champs, et non un tableau.
Corps de requête POST
Exemple de corps de requête pour POST /ApiUser :
{
"OperatorGuid": "ef45547g-0f8h-46a2-acef-dd1e15571390",
"Description": "API description"
}
Le OperatorGuid doit correspondre à l’utilisateur API existant. Une mise à jour réussie renvoie 204 No content.
Corps de requête PUT
Exemple de corps de requête pour PUT /ApiUser/{apiUserGuid} :
{
"OperatorGuid": "ef45547g-0f8h-46a2-acef-dd1e15571390",
"Description": "Updated API description"
}
Une mise à jour réussie renvoie 204 No Content.
Paramètres de la ApiUser API
| Nom du champ | Description |
|---|---|
OperatorGuid |
Paramètre de chemin. Le GUID de l’opérateur dont vous souhaitez récupérer les utilisateurs API. |
ApiUserGuid |
Paramètre de chemin. Le GUID de l’utilisateur API à récupérer, mettre à jour ou supprimer. |
Champs de la ApiUser API
Remarque
Certains champs ApiUser sont en lecture seule ou automatiquement attribués par l’API.
Les ressources ApiUser utilisent les propriétés suivantes dans les corps de requête et de réponse :
| Nom du champ | Description |
|---|---|
ApiUserGuid |
L’identifiant unique de l’utilisateur API. Attribué automatiquement lors de la création d’un utilisateur API. |
OperatorGuid |
L’identifiant unique de l’opérateur associé à cet utilisateur API. Obligatoire dans les corps de requête POST et PUT. Vous ne pouvez pas modifier le OperatorGuid d’un utilisateur API existant dans une requête PUT. |
UserName |
Le nom d’utilisateur utilisé avec le mot de passe pour authentifier les requêtes API. Attribué automatiquement lors de la création d’un utilisateur API. En lecture seule. |
Password |
Le mot de passe utilisé avec le nom d’utilisateur pour authentifier les requêtes API. Attribué automatiquement lors de la création d’un utilisateur API. Omis des réponses GET. Non inclus dans les corps de requête POST ou PUT. |
Type |
Identifie le client ou l’application qui utilise les identifiants API. Attribué automatiquement par l’API. En lecture seule.
|
Description |
Détails de l’utilisateur API. Par exemple, Transaction Recorder ou Private Location healthchecks. |
CreatedDate |
Date et heure de création de l’utilisateur API. En lecture seule. |
LastUsed |
Date et heure de la dernière requête API. En lecture seule. |
UsageLast30Days |
Nombre de requêtes effectuées au cours des 30 derniers jours. En lecture seule. |
Dépannage
Cette section présente les erreurs HTTP courantes et les étapes de dépannage pour la ApiUser API.
Erreurs courantes
Codes d’état HTTP courants et leurs descriptions :
| Code d’état | Description |
|---|---|
| 200 | OK — requête réussie. |
| 201 | Created — l’utilisateur API a été créé avec succès. Le corps de la réponse contient le nouvel utilisateur API, y compris le ApiUserGuid attribué. |
| 204 | No content — la requête s’est terminée avec succès et aucun corps de réponse n’a été renvoyé. Cela s’applique aux requêtes PUT et DELETE réussies. |
| 400 |
|
| 401 | Unauthorized — identifiants d’authentification non valides ou manquants. |
| 403 | Forbidden — une ou plusieurs erreurs de validation se sont produites. Cela peut être lié aux autorisations du compte. |
| 404 | Not Found — le operatorGuid ou le apiUserGuid spécifié est introuvable. |
| 500 | Internal Server Error — une erreur côté serveur s’est produite. |
Guide général de dépannage
Assurez-vous de :
- Toujours valider les données de votre requête avant d’envoyer des appels API.
- Utiliser les méthodes HTTP appropriées pour chaque opération.
Pour obtenir une aide supplémentaire, veuillez contacter notre équipe Support.
Articles connexes
Pour plus de détails, consultez les articles suivants :
- Documentation de la ApiUser API Uptrends — documentation API interactive avec des spécifications d’endpoint détaillées.
- Changelog de l’API — dernières mises à jour de l’API et avis de dépréciation.