De Gegevensexport-API uitproberen

Volg deze procedure voor een korte inleiding tot de API, waarbij u de interactieve documentatiepagina als leidraad gebruikt.

Voordat u met deze taak begint, dient u een API-sleutel aan te maken via RICOH Account Administration.

Deze procedure leidt u door de volgende stappen:

Verificatie van de interactieve documentatiepagina
De lijst met printer-ID’s voor de printers in uw account ophalen
De status van één of meer printers opvragen
Informatie opvragen over taken die verband houden met een of meer van die printers

Om de Gegevensexport-API te gebruiken:

Open hier de interactieve documentatie van de Gegevensexport-API:
- De VS en Japan: https://rpi-data-export.app-ricohsoftware.com/api/v1/api-docs
- Europa: https://rpi-data-export.app-ricohsoftware.eu/api/v1/api-docs
Authenticeren met behulp van een API-sleutel:
1. Klik op Autoriseren aan de rechterkant van de pagina.
2. Voer in het dialoogvenster Beschikbare autorisaties uw API-sleutel in het veld Waarde in.
1. Klik op Autoriseren om u te authenticeren.
2. Klik op Sluiten.
U kunt nu de beschikbare API-functies testen. Gebruik deze interface om vertrouwd te raken met de syntaxis voordat u de API in uw applicaties integreert.
Haal de lijst met printer-ID’s op voor de printers die in uw account zijn gedefinieerd.
Om informatie over de status van afdruktaken en printers op te vragen, dient u de printer-ID’s in uw API-verzoeken op te nemen. Printer-ID’s veranderen niet. Als u ze nu opvraagt en de waarden opslaat, kunt u de ID’s in andere API-aanroepen gebruiken.
1. Open het gedeelte Printers en open vervolgens het endpoint GET /printers.
  U ziet dat er voor dit endpoint geen parameters nodig zijn.
2. Klik op Probeer het eens en vervolgens op Uitvoeren.
3. Controleer de inhoud van het antwoord. U ziet een lijst met gegevens over de printers die worden bewaakt door RICOH Predictive Insight. Het antwoord ziet er ongeveer zo uit:
```
[
  {
    "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"
  }
]
```
  Noteer de waarden van de printerId-parameters voor elk van uw printers.
Vraag de printerstatusgeschiedenis op van één of meer printers in uw systeem.
1. Open het endpoint GET /printer-states.
2. Klik op Probeer het uit.
3. Klik naast printerId op Tekenreeks toevoegen.
4. Vervang de tekst in het veld door een van de printer-ID-waarden die u in stap hebt opgehaald.
  Om de statusgeschiedenis voor andere printers op te halen, klikt u nogmaals op Tekenreeks toevoegen en voegt u nog een printer-ID toe.
5. Kies bij tijdzone de tijdzone die u voor de gegevens wilt gebruiken.
6. Geef de begin- en eindtijd op voor de periode waarover u een rapport wilt genereren. Laat deze velden leeg om gegevens van de afgelopen 24 uur op te halen.
7. Laat de laatste drie waarden op de standaardinstelling staan, zodat u de volledige lijst met informatie kunt zien die de API kan retourneren.
8. Klik op Uitvoeren.
9. Controleer de inhoud van het antwoord. U ziet een lijst met gegevens over de printerstatus voor elke printerengine, met één regel per wijziging in de printerstatus.
10. Wijzig de waarden voor de parameters currentState, stateCategoryOnly en stateCategory en klik opnieuw op Uitvoeren om te zien hoe het antwoord verandert.
  - Als u deze parameters op de standaardinstelling (niet ingesteld) laat staan, heeft dit hetzelfde effect als wanneer u ze op onwaar instelt.
  - U kunt deze afzonderlijk of in combinatie met elkaar gebruiken.
Vraag informatie aan over taken die verband houden met een of meer van deze printers:
1. Ga naar het gedeelte Taken op de pagina.
2. Open het endpoint GET /jobs.
3. Klik op Probeer het uit.
4. Klik naast printerId op Tekenreeks toevoegen.
5. Vervang de tekst in het veld door een van de printer-ID-waarden die u in stap hebt opgehaald.
  Om taakinformatie voor extra printers op te halen, klikt u nogmaals op Tekenreeks toevoegen en voegt u nog een printer-ID toe.
6. Kies bij tijdzone de tijdzone die u voor de gegevens wilt gebruiken.
7. Geef de begin- en eindtijd op voor de periode waarover u een rapport wilt genereren. Laat deze velden leeg om gegevens van de afgelopen 24 uur op te halen.
8. Laat het veld Taakstatus leeg om het volledige scala aan antwoorden te zien dat de API kan retourneren.
9. Klik op Uitvoeren.
10. Bekijk het antwoord om de teruggestuurde taakinformatie te bekijken.
11. Wijzig de waarde van Taakstatus en klik nogmaals op Uitvoeren om te zien hoe het antwoord verandert.