Introduction

This page describes the Infiniti REST Application Programming Interface.

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

The Infiniti REST API is separated into two Parts: Client and Administrator APIs. Each covers the functionality of Infiniti Produce and Infiniti 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 Infiniti Workflow.

The Administrator module allows you to:

• Project basic functions such as Get, Import/Export, Rename, Delete and Get Version History of an Infiniti project.
• Perform basic functions of Create, Read, Update, Delete Content Folders and Publish Folders.
• Perform basic functions of Create, Read, Update, Delete Infiniti Users, Groups and Roles.
• Perform admin decisions on Infiniti workflows such as Get, Abort, and Reassign.
• Retrieve and Update License details.
• Perform basic functions of Create, Read, Update, and Delete Infiniti Data Sources.
• 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, Infiniti REST API uses Bearer Authentication (also called token authentication) that involves security tokens called bearer tokens. When you are making requests to Infiniti protected resources, you must send Infiniti generated authorization token in the Authorization header. A single Bearer token can be used interchangeably between the Client and Admin APIs.

🚧

Special-character encoding for username endpoints

The /api/v1/admin/users/name/<name> endpoint requires additional IIS configuration to support retrieving details for users with special characters in the username (a common example is the username being an email address).

The required changes are:

• Add the allowDoubleEscaping="true" directive to the system.webServer/security/requestFiltering node in web.config
• URL-encode special characters (e.g. @ should become %40, and so on)
• Add a trailing slash to the request path

For example, the correct path for retrieving the details of the user with username [email protected] would be /api/v1/admin/users/name/user%2Ename%40example%2Ecom/