Integrating Cloud Fleet Management to third-party software

The integration API provides endpoints to facilitate integrations with third-party software. Use the following methods and keys to integrate Lexmark Cloud Fleet Management to your system:

Retrieve Asset Counters

This call retrieves the counters, such as meters, for the assets in an organization and its child organizations. The organization is determined from the token specified in the Authorization header, which must be retrieved from the Retrieve Token call.

Note: This endpoint is now deprecated with the introduction of the API version 1.0 endpoints.

Method

URL

GET

<INTEGRATION_SERVICE_URL>/assets/inventory/counters


Headers

Key

Value

Description

Authorization

Bearer <TOKEN>

The Retrieve Token call returns the token.


Body

None.

Return schema

{
    "type": "array",
    "items": {
        "type": "object",
        "required": [ "serialNumber", "dateCollected", "counters" ],
        "properties": {
            "serialNumber": { "type": "string" },
            "dateCollected": { "type": "integer" },
            "counters": { 
                "type": "object",
                "properties": {
                    "lifetimeCount": { "type": "integer" },
                    "colorPrintSideCount": { "type": "integer" },
                    "colorPrintSheetCount": { "type": "integer" },
                    "monoPrintSideCount": { "type": "integer" },
                    "monoPrintSheetCount": { "type": "integer" },
                    "printSideCount": { "type": "integer" },
                    "printSheetCount": { "type": "integer" },
                    "colorCopySideCount": { "type": "integer" },
                    "colorCopySheetCount": { "type": "integer" },
                    "monoCopySideCount": { "type": "integer" },
                    "monoCopySheetCount": { "type": "integer" },
                    "copySideCount": { "type": "integer" },
                    "copySheetCount": { "type": "integer" },
                    "colorFaxSideCount": { "type": "integer" },
                    "colorFaxSheetCount": { "type": "integer" },
                    "monoFaxSideCount": { "type": "integer" },
                    "monoFaxSheetCount": { "type": "integer" },
                    "faxSideCount": { "type": "integer" },
                    "faxSheetCount": { "type": "integer" },
                    "colorSideCount": { "type": "integer" },
                    "colorSheetCount": { "type": "integer" },
                    "monoSideCount": { "type": "integer" },
                    "monoSheetCount": { "type": "integer" },
                    "totalSideCount": { "type": "integer" },
                    "totalSheetCount": { "type": "integer" },
                    "largeSideCount": { "type": "integer" },
                    "largeSheetCount": { "type": "integer" },
                    "duplexSideCount": { "type": "integer" },
                    "duplexSheetCount": { "type": "integer" },
                    "coverageTierBusinessSideCount": { "type": "integer" },
                    "coverageTierBusinessSheetCount": { "type": "integer" },
                    "coverageTierGraphicsSideCount": { "type": "integer" },
                    "coverageTierGraphicsSheetCount": { "type": "integer" },
                    "coverageTierHighlightSideCount": { "type": "integer" },
                    "coverageTierHighlightSheetCount": { "type": "integer" },
                },
            },
        },
    },
    "minItems": 0
}

Sample response

[
  {
    "serialNumber": "14",
    "dateCollected": 1557259523000,
    "counters": {
      "monoPrintSideCount": 262,
      "printSideCount": 262,
      "printSheetCount": 262,
      "monoCopySideCount": 40,
      "copySideCount": 40,
      "copySheetCount": 40,
      "monoFaxSideCount": 0,
      "faxSideCount": 0,
      "faxSheetCount": 0,
      "monoSideCount": 302,
      "totalSideCount": 302,
      "totalSheetCount": 302,
      "duplexSheetCount": 0
    }
  },
  {
    "serialNumber": "29",
    "dateCollected": 1557259523000,
    "counters": {
      "lifetimeCount": 139,
      "monoPrintSideCount": 139,
      "printSideCount": 139,
      "printSheetCount": 136,
      "copySideCount": 0,
      "monoSideCount": 139,
      "totalSideCount": 139,
      "totalSheetCount": 136,
      "duplexSheetCount": 3
    }
  },
  {
    "serialNumber": "36",
    "dateCollected": null,
    "counters": {
    }
  }
]

Retrieve Token

This call generates a token that is suitable for use with the Retrieve Asset Counters call.

Method

URL

POST

<IDP_URL>oauth/token


Note: <IDP_URL> is either https://idp.eu.iss.lexmark.com for an organization in the EU data center or https://idp.us.iss.lexmark.com/ for an organization in the U.S. data center.
Headers

Key

Value

Content-Type

application/json


Body

{
    "grant_type": "client_credentials",
		 "client_id": "<CLIENT_ID>",
		 "client_secret": "<CLIENT_SECRET>"
}

Return schema

{
    "properties" : {
        "access_token": {"type": "string"},
        "token_type": {"type": "string"},
        "expires_in": {"type": "integer"},
        "created_at": {"type": "integer"}
    },
    "required": ["access_token", "token_type", "expires_in", "created_at"]
}

Sample response

{
    "access_token": "abcd1234",
    "token_type": "bearer",
    "expires_in": 7200,
    "created_at": 1572633120
}