Kyocera KFSNew Integration
Integrating PrintReleaf with Kyocera KFS
PrintReleaf now integrates with Kyocera KFS to securely and reliably sync paper consumption data from your KFS instance.
On a nightly basis, PrintReleaf performs a data collection process that connects to your KFS instance via the Kyocera Fleet Services External System Integration API. PrintReleaf retrieves and processes paper consumption metrics for each of your customers and deposits the data into the customer’s PrintReleaf account.
At the end of each month, PrintReleaf totals each customer’s paper consumption for that month, equates it to forest impact measured in trees, and issues a Certificate of Reforestation to the customer certifying that their paper consumption has been reforested.
Configuring the Integration
At a high-level, setup of the PrintReleaf/KFS integration involves two parts:
- Registering your KFS server in your PrintReleaf dashboard
- Connecting customer feeds to map your KFS customers to their respective accounts in PrintReleaf
You will need the following KFS credentials to register your server:
- URL: The web URL of your KFS instance (ex: https://api.kyods.com)
- Username & Password: Login credentials for a user of your KFS Web Portal. As a best practice, it is highly recommended you create a new KFS user specifically for the PrintReleaf integration.
- Location: The region where your KFS instance is located. The PrintReleaf integration is currently available in the following regions: KFS_EU.
To register your KFS server in PrintReleaf, you provide the URL of your KFS server and Username & Password credentials that PrintReleaf will use to connect to your KFS server.
Once your KFS server is registered in PrintReleaf, you can begin registering individual customer feeds that should be synchronized with your KFS server.
To register a customer feed, you select the customer’s KFS Group from the dropdown menu which is populated with the list of groups on your KFS server, the Activation Date, and Sync Settings.
The KFS Group is used by PrintReleaf to identify the matching customer in KFS.
The Activation Date is the date PrintReleaf should begin synchronizing data for this customer; if it is set to a date in the past, PrintReleaf will automatically sync historical data back to that date.
In Sync Settings, you have the option to synchronize paper consumption from all of the customer’s devices, or only devices marked as ‘managed’.
For complete step-by-step configuration instructions, please view the Kyocera KFS Integration Setup Guide.
Data Collection & Flow
PrintReleaf’s data collectors will attempt to connect to your KFS server on a nightly basis to retrieve and process customer paper consumption data. Individual customers are batched and synchronized one after another in a serial fashion.
The duration of a data collection is dependent on a number of factors, including current load on your KFS server, the number of customers to be synchronized, and network latency due to geographic distance to your server. Most individual customer data collections finish in between 1 and 2 seconds.
Customer data only flows from KFS to PrintReleaf; PrintReleaf never writes new data to your KFS server.
KFS Customer Data provided to PrintReleaf
PrintReleaf uses the Kyocera Fleet Services External System Integration API to securely connect to your server and retrieve customer paper consumption data. When performing a customer data collection, PrintReleaf calls the DeviceList API endpoint. The DeviceList endpoint returns information about the device (e.g. DeviceID and management status) as well as counters for each of the meters on the device. PrintReleaf synchronizes the meter data with its own database, calculates the daily deltas, and deposits the page counts to the customer’s account.
KFS device data fields stored by PrintReleaf:
- DeviceID: Unique identifier for this device supplied by KFS
- Managed: Device management status
- InitialCount: The initial lifecount on the device recorded the first time it was synced with PrintReleaf
- LatestCount: The most recently recorded lifecount on the device PrintReleaf
- LifeCount: The number of pages since syncing with PrintReleaf (LatestCount–InitialCount)
PrintReleaf does not store any other data about the customer or their devices.
Integration Health Checks
PrintReleaf actively monitors the health of your KFS integration on two levels: the server level and the feed level.
The server health check is performed by attempting to connect to your KFS server using the credentials provided during registration. Failed attempts to connect will immediately mark the server as unhealthy and will pause customer data collection until the health check passes again.
At the individual feed level, PrintReleaf monitors the flow of inbound paper consumption data. If the feed has not received new data from KFS in 3 business days, the feed is marked as unhealthy. This often indicates the DCA is stale. When a feed becomes healthy again, PrintReleaf automatically synchronizes data back in time to when the feed became unhealthy, ensuring paper consumption data is never missed.
In transit, all network traffic to and from PrintReleaf’s web servers, data collectors, and APIs is transmitted via HTTPS. HTTP requests are not permitted. At rest, sensitive data (e.g. server credentials) are encrypted using industry standard hashing functions and ciphers.
Personal Data Security & PII
Still have questions?
Can't find the answer you're looking for? Get in touch with us.
Ready To Make A Difference?
As a Managed Print Services provider, you understand the significance of paper usage, and embracing more sustainable printing practices is becoming a vital part to doing business. Your customers rely on you to ensure smooth operations. Let's explore how PrintReleaf can support your business, deliver added value to your customers, and help you contribute to a greener planet.Start the conversation