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.

Avant de commencer cette tâche, veuillez créer une clé API à l'adresse RICOH Account Administration.

Cette procédure vous guide à travers les étapes suivantes :

  1. Authentification sur la page de documentation interactive
  2. Récupération de la liste des identifiants des imprimantes associées à votre compte
  3. Récupération de l'état d'une ou plusieurs imprimantes
  4. Demande d'informations concernant les travaux associés à une ou plusieurs de ces imprimantes

Pour utiliser l'API d'exportation de données :

  1. Pour consulter la documentation interactive de l'API d'exportation de données, cliquez ici :
  2. S'authentifier à l'aide d'une clé API :
    1. Cliquez sur Autoriser à droite de la page.
    2. Dans la boîte de dialogue Autorisations disponibles, saisissez votre clé API dans le champ Valeur.
      Boîte de dialogue Autorisations disponibles
    1. Cliquez sur Autoriser pour vous authentifier.
    2. Cliquez sur Fermer.
    Vous pouvez désormais tester les fonctions de l'API disponibles. Utilisez cette interface pour vous familiariser avec la syntaxe avant d'intégrer l'API à vos applications.
  3. Récupérez la liste des identifiants des imprimantes définies dans votre compte.
    Pour récupérer des informations sur l'état des travaux et des imprimantes, vous devez inclure les identifiants des imprimantes dans vos requêtes API. Les identifiants d'imprimante ne changent pas. Si vous les récupérez maintenant et que vous enregistrez les valeurs, vous pourrez utiliser ces identifiants dans d'autres appels d'API.
    1. Ouvrez la section Imprimantes, puis ouvrez le point de terminaison GET /printers.
      Comme vous pouvez le constater, aucun paramètre n'est requis pour ce point de terminaison.
    2. Cliquez sur Essayer, puis sur Exécuter.
    3. Vérifiez le corps de la réponse. Vous pouvez consulter la liste des informations détaillées concernant les imprimantes surveillées par RICOH Predictive Insight. La réponse ressemble à ceci :
      [
  {
    "printerName": "VC80_2",
    "printerId": "0bc6b7b3-8df9-4293-cdd4-5ae3162c4d4c",
    "engines": 2,
    "manufacturer": "Ricoh",
    "model": "RICOH Pro VC80000",
    "printerMode": "duplex",
    "printerType": "continuous_feed",
    "serialNumber": "Printer 1: 10-11111 and Printer 2: 10-11112",
    "connectionStatus": "not_connected"
  },
  {
    "printerName": "IP 5000",
    "printerId": "0f8726da-8q37-9c3l-8710-065d7c265122",
    "engines": 1,
    "manufacturer": "InfoPrint",
    "model": "InfoPrint 5000 GP v3.17.129",
    "printerMode": "simplex",
    "printerType": "continuous_feed",
    "serialNumber": "10-1111111",
    "connectionStatus": "connected"
  }
]

      Notez les valeurs des paramètres printerId pour chacune de vos imprimantes.

  4. Demandez l'historique de l'état d'une ou plusieurs imprimantes de votre système.
    1. Ouvrez le point de terminaison GET /printer-states.
    2. Cliquez sur Essayer.
    3. À côté de printerId, cliquez sur Ajouter un élément de chaîne.
    4. Remplacez le texte figurant dans le champ par l'une des valeurs d'identifiant d'imprimante que vous avez récupérées à l'étape .
      Pour récupérer l'historique des états d'autres imprimantes, cliquez à nouveau sur Ajouter un élément de chaîne et ajoutez une autre valeur d'identifiant d'imprimante.
    5. Pour le fuseau horaire, choisissez celui que vous souhaitez utiliser pour les données.
    6. Veuillez indiquer les heures de début et de fin de la période sur laquelle porte le rapport. Ne remplissez pas ces champs pour récupérer les données des dernières 24 heures.
    7. Laissez les trois dernières valeurs sur leur valeur par défaut afin de pouvoir consulter la liste complète des informations que l'API peut renvoyer.
    8. Cliquez sur Exécuter.
    9. Vérifiez le corps de la réponse. Vous voyez une liste des données relatives à l'état de chaque moteur d'impression, avec une ligne pour chaque changement d'état de l'imprimante.
    10. Modifiez les valeurs des paramètres currentState, stateCategoryOnly et stateCategory, puis cliquez à nouveau sur Exécuter pour observer l'évolution de la réponse.
      • Si vous laissez ces paramètres à leur valeur par défaut (non définis), cela revient à les définir sur faux.
      • Vous pouvez les utiliser séparément ou en les combinant entre eux.
  5. Demandez des informations sur les travaux associés à une ou plusieurs de ces imprimantes :
    1. Rendez-vous dans la rubrique Travaux de la page.
    2. Ouvrez le point de terminaison GET /jobs.
    3. Cliquez sur Essayer.
    4. À côté de printerId, cliquez sur Ajouter un élément de chaîne.
    5. Remplacez le texte figurant dans le champ par l'une des valeurs d'identifiant d'imprimante que vous avez récupérées à l'étape .
      Pour récupérer les informations sur les travaux pour d'autres imprimantes, cliquez à nouveau sur Ajouter un élément de chaîne et ajoutez une autre valeur d'identifiant d'imprimante.
    6. Pour le fuseau horaire, choisissez celui que vous souhaitez utiliser pour les données.
    7. Veuillez indiquer les heures de début et de fin de la période sur laquelle porte le rapport. Ne remplissez pas ces champs pour récupérer les données des dernières 24 heures.
    8. Pour le paramètre jobState, laissez le champ vide afin de voir l'ensemble des réponses que l'API peut renvoyer.
    9. Cliquez sur Exécuter.
    10. Consultez la réponse pour voir les informations sur les travaux qui vous ont été renvoyées.
    11. Modifiez la valeur de jobState et cliquez à nouveau sur Exécuter pour observer l'évolution de la réponse.
Rubrique parente : Utilisation de l'API d'exportation de données