HomeGuidesAPILog In


This page describes the SmartIQ REST Application Programming Interface.

The SmartIQ REST API provides endpoints for SmartIQ data types that allow developers to interact with SmartIQ remotely by sending and receiving JSON objects.

The SmartIQ REST API is separated into two Parts: Client and Administrator APIs. Each covers the functionality of SmartIQ Produce and SmartIQ Manage respectively.

The Client API allows you to:

  • Automate back-end processes such as document generation.
  • Retrieve state of resources and any extended information.
  • Retrieve a list of outputs and locations of previously generated project submission.
  • Perform basic functions of Create, Read, Update and, Delete Answer Files and in-progress Answer Files.
  • Perform basic functions of Get, Unlock, Cancel, and Reassign SmartIQ Workflow.

The Administrator module allows you to:

  • Project basic functions such as Get, Import/Export, Rename, Delete and Get Version History of a SmartIQ project.
  • Perform basic functions of Create, Read, Update, Delete Content Folders and Publish Folders.
  • Perform basic functions of Create, Read, Update, Delete Users, Groups and Roles.
  • Perform admin decisions on workflows such as Get, Abort, and Reassign.
  • Retrieve and Update License details as well as Transaction Reports. See here for example projects for transaction reports
  • Perform basic functions of Create, Read, Update, and Delete Data Connections.
  • Perform basic functions of Create, Read, Update, and Delete Content Library Items.

API Notes

  • The current version of this API is version 1.
  • This API is RESTful.
  • The base URL of the Client module is: {{YourProduceURL}}/api/v1/client/
  • The base URL of the Administrator module is: {{YourManageURL}}/api/v1/admin/
  • For Authentication, SmartIQ REST API uses Bearer Authentication (also called token authentication) that involves security tokens called bearer tokens. When you are making requests to SmartIQ protected resources, you must send SmartIQ generated authorization token in the Authorization header. A single Bearer token can be used interchangeably between the Client and Admin APIs.