Utilisation de l'API d'exportation de données

Grâce à l'API d'exportation de données, vous pouvez extraire les informations collectées par RICOH Predictive Insight afin de les utiliser dans d'autres processus et outils au sein de votre organisation.

L'API d'exportation de données permet d'accéder par programmation aux informations relatives à l'imprimante, à l'historique des travaux, aux données d'état de l'imprimante et aux événements d'intervention sur l'imprimante. Vous pouvez l'utiliser pour alimenter des outils de reporting, remplir des tableaux de bord, archiver des données opérationnelles ou intégrer des données RICOH Predictive Insight à d'autres systèmes de votre environnement.

In this section:

  1. API d'exportation de données
    L'API d'exportation de données est une API REST qui propose quatre points de terminaison. Vous pouvez utiliser ces points de terminaison pour télécharger des informations concernant vos imprimantes et les travaux qu'elles ont traités, ainsi que l'historique de leur état de fonctionnement et les événements ayant déclenché des messages d'avertissement ou d'erreur sur l'imprimante.
  2. Création et gestion des clés API
    Une clé API autorise les requêtes adressées à l'API d'exportation de données. Vous créez et gérez vos clés API sur Account Administration, et vous indiquez cette clé lorsque vous envoyez des requêtes depuis la page « Explorateur d'API » ou depuis vos propres applications.
  3. Tester l'API d'exportation de données
    Suivez cette procédure pour découvrir brièvement l'API, en vous aidant de la page de documentation interactive.
  4. Gestion de la date et de l'heure dans l'API d'exportation de données
    L'API d'exportation de données utilise un modèle unique et cohérent pour le traitement des dates et des heures : chaque requête indique un fuseau horaire IANA, chaque valeur de date et d'heure est interprétée selon ce fuseau horaire, et chaque valeur de date et d'heure figurant dans la réponse est formatée selon ce même fuseau horaire. Consultez cette rubrique pour comprendre le fonctionnement du modèle et éviter les erreurs courantes.
  5. Champs de réponse de l'API d'exportation de données
    Chaque point de terminaison de l'API d'exportation de données renvoie un tableau JSON d'objets. Utilisez les tables figurant dans cette rubrique pour interpréter les champs de chaque réponse.
  6. Exemples de requêtes et de réponses de l'API d'exportation de données
    Utilisez les exemples présentés dans cette rubrique comme point de départ pour votre propre intégration. Chaque exemple présente une URL de requête représentative ainsi que le corps de la réponse renvoyée par l'API.
  7. Dépannage de l'API d'exportation de données
    Utilisez cette rubrique pour interpréter les réponses d'erreur courantes de l'API d'exportation de données et pour identifier la cause la plus probable ainsi que la solution à apporter pour chacune d'entre elles. Chaque réponse d'erreur comprend un code, un message et un statusCode numérique ; la valeur code identifie la condition spécifique.

Related information:

Création et gestion des clés API
Onglet Clés API
Clés API
Rubrique parente : RICOH Account Administration