Using TotalFlow Optimizer APIs

TotalFlow Optimizer provides REST APIs for web service integration. Interactive documentation is provided with these APIs and provides live testing and information for each available API.

The REST API documentation includes many APIs that an application can use to integrate with TotalFlow Optimizer. You can use the REST API documentation and testing interface to test your parameter settings. It uses common HTTP methods and JSON payloads to send print jobs, retrieve batch information, query printer status, and manage device configurations remotely.

These steps demonstrate how to get information about orders using REST APIs.

  1. Go to Admin ⇒ Other ⇒ API Keys.
  2. Create a new API key or use an existing API key that is enabled and not expired.
  3. Copy the API key.
  4. Click API Documentation to access the API documentation.
  5. Click Authorize on the upper right side of the screen.
  6. In the Available authorization dialog, paste the key in the Value field.
  7. Click Authorize to save the API key.
  8. To close the Available authorizations dialog and save the settings, click Close.
  9. Go to the order section and find GET /order.
  10. Click Try it out.
  11. Click Execute.
    The REST API documentation uses the values to build a Curl command and a Request URL. Then it submits the request to the request URL and retrieves the list of orders.
  12. In the Response Body box, you find the information retrieved.
    You might want to review the output to make sure it contains the correct information and structure.
    You can copy the text or download the JSON file.

    After you determine the settings you need to generate the results required, copy the Curl command and Request URL to use with your application.

Parent topic: Configuration