Gegevensexport-API

De gegevensexport-API is een REST-API die vier eindpunten biedt. U kunt deze eindpunten gebruiken om informatie te downloaden over uw printers en de taken die zij hebben verwerkt, evenals de bedrijfsstatus van die printers in de loop van de tijd en gebeurtenissen die aanleiding hebben gegeven tot waarschuwings- of foutmeldingen op de printer.

U kunt de gegevensexport-API gebruiken om gegevens uit de RICOH Predictive Insight te importeren in business intelligence-tools, datawarehouses, dashboards en andere applicaties binnen uw organisatie.

Verificatie

U kunt API-sleutels aanmaken en beheren op RICOH Account Administration. U kunt zoveel sleutels aanmaken als u nodig heeft: één per toepassing die gegevens downloadt of één sleutel voor gebruik binnen uw hele organisatie. Stel de vervaldatum vast in overeenstemming met uw beveiligingsbeleid en wissel de sleutels indien nodig af. U kunt de overlappingsperiode instellen, zodat zowel de oude als de nieuwe sleutels gedurende een aantal dagen werken. Indien nodig kunt u een sleutel verwijderen om deze onmiddellijk te deactiveren.

De API-sleutel bevat tevens uw tenant-identiteit; daarom is bij geen enkel verzoek een tenant- of accountparameter vereist. Iedereen die over de sleutelwaarde beschikt, kan verzoeken indienen als uw tenant; beveilig API-sleutels daarom op dezelfde manier als u een wachtwoord zou beveiligen.

Beschikbare eindpunten

De API bevat de volgende eindpunten:

/printers

Geeft de lijst met printers in uw account weer, inclusief de naam van de printer, het model, de fabrikant, het serienummer, de printkoppen en de huidige status van de verbinding.

/jobs

Geeft details op taakniveau weer voor één of meer printers, waaronder tijdstippen, afgedrukte exemplaren, pagina’s, afdrukken, vellen, rollengte en het verbruik van inkt en spoelen per kleurkanaal. Standaard heeft het overzicht betrekking op de afgelopen 24 uur.

/printer-states

Geeft de bedrijfsstatus van elke printerengine weer, hetzij als een samengevatte geschiedenis over een bepaald tijdsbestek, hetzij uitsluitend als de huidige status. U kunt de actuele statussen van de printer opvragen, zoals: Bezig met afdrukken, Bezig met voorbereiden, Onderhoud of Slaapstand, of deze statussen kunnen worden gegroepeerd in de volgende categorieën: up, down, idle of unknown.

Tip: Het eindpunt /printer-states geeft statusinformatie weer per printerengine, niet per printer. Een printer met meerdere printmotoren geeft één rij per printmotor weer.

/printer-interventions

Geeft de gebeurtenissen weer die op één of meer printers tot waarschuwingen of fouten hebben geleid, zoals een papierstoring of een lege mediabron. Elke gebeurtenis wordt per afdrukmechanisme gerapporteerd, met vermelding van het tijdstip waarop deze begon, het tijdstip waarop deze eindigde, de duur ervan, een code die de voorwaarde aangeeft en, indien van toepassing, de naam van de taak die op dat moment werd afgedrukt. Standaard heeft het overzicht betrekking op de afgelopen 24 uur. U kunt beschrijvingen van evenementen aanvragen in elk van de ondersteunde talen.

De API testen

Er is een interactieve documentatiepagina beschikbaar waarmee u elk eindpunt kunt bekijken, kunt zien welke parameters het accepteert en voorbeeldverzoeken rechtstreeks vanuit uw browser kunt uitproberen. Om de pagina te openen, gaat u naar:

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

Om verzoeken in te dienen via de documentatiepagina of vanuit uw eigen applicaties, dient u eerst een API-sleutel aan te maken. U kunt API-sleutels aanmaken en beheren op Account Administration.