Real Time Printer API

The Real Time Printer API provides the current state of all printers in your fleet. The following information is available about each printer using  HTTP GET

https://printerpoint.com/apis/v1/dealer/printers

• Customer name
• Customer ID
• Serial number
• Printer nickname
• Asset ID
• Printer make
• Printer model
• IP address
• Firmware version
• Location name
• Last seen date/time
• Lifetime paper and colorant counters
• Cartridge levels

The lifetime counters reported will vary from printer to printer. The Printerpoint API will return all available counters per printer, not just the counters used by the billing method you have defined in Printerpoint.

Paper Counters Available for Large Format Printers

• Paper Length in Micrometers
• Paper Area Monochrome in Hundredths of a Square Millimeter
• Paper Area Color in Hundredths of a Square Millimeter
• Paper Area Total In Hundredths of a Square Millimeter
• HP Specific Print Category Counters
• Monochrome Lines in Hundredths of a Square Millimeter
• Color Lines in Hundredths of a Square Millimeter
• Low Density Images in Hundredths of a Square Millimeter
• High Density Images in Hundredths of a Square Millimeter
• Special Media Plots in Hundredths of a Square Millimeter

Paper Counters Available for Small Format Printers

• Colored Pages by Monochrome in Clicks
• Colored Pages by Color in Clicks
• Colored Pages by Size Monochrome Total in Clicks
• Colored Pages by Size Monochrome Tabloid in Clicks
• Colored Pages by Size Color Total in Clicks
• Colored Pages by Size Color Color in Clicks
• Colored Pages by Size Scans in Clicks

Colorant (Ink/Toner) Counters Available for Large Format and Small Format Printers

• Colorant Volume in Microliters
• Colorant Weight in Milligrams

The Printers endpoint returns a list of printers in ascending order. Up to N printers will be returned at a time and the 'next' link in the returned page can be used to get additional printers.

Sample result:

HTTP GET

https://printerpoint.com/apis/v1/dealer/printers  

Response sample:

{
  "links": {
    "next": "https://example.com/link-to-another-batch-of-printers"
  },
  "results": [
     {
      "customerCompanyName": "Customer, Inc",
      "customerCompanyId": "ABCZ586",
      "serialNumber": "jkl69643",
      "nickname": "First floor Canon",
      "assetId": "4634qwe",
      "make": "xerox",
      "modelName": "iPF 6460",
      "ipV4Address": "192.168.0.10",
      "firmwareVersion": "v197.97",
      "locationName": "Dallas Office",
      "lastSeen": "2013-07-26T16:45:20.1234567Z",
      "lifetimeConsumption": {
        "paperLengthInMicrometers": 500000000,
        "colorantVolumeInMicroliters": 2000000,
        "colorantWeightInMilligrams": 250000,
        "paperAreaByColor": {
          "monochromeInHundredthsOfASquareMillimeter": 11000000000,
          "colorInHundredthsOfASquareMillimeter": 12000000000,
          "totalInHundredthsOfASquareMillimeter": 13000000000
        },
        "paperAreaByPageContent": {
          "monochromeLinesInHundredthsOfASquareMillimeter": 11000000000,
          "colorLinesInHundredthsOfASquareMillimeter": 12000000000,
          "lowDensityImagesInHundredthsOfASquareMillimeter": 13000000000,
          "highDensityImagesInHundredthsOfASquareMillimeter": 14000000000,
          "specialMediaPlotsInHundredthsOfASquareMillimeter": 15000000000
        },
        "coloredPages": {
          "monochrome": 2000,
          "color": 1000
        },
        "coloredPagesBySize": {
          "monochromeTotal": 2000,
          "monochromeLarge": 1500,
          "colorTotal": 1200,
          "colorLarge": 1100,
          "scans": 1000
        }
      },
      "cartridges": [
        {
          "colorName": "Black",
          "lastReplacedOn": "2013-07-26T16:45:20.1234567Z",
          "productName": "HP 727",
          "productNumber": "B3P20A",
          "colorantCapacityInMicroliters": 700000,
          "colorantRemainingInMicroliters": 432000,
          "percentageOfColorantRemaining": 72.45
        }
      ]
    }
  ]
}