About the Zift PRM API

Overview

The Zift Solutions API adheres to REST API standards. The API Call limits are set by Zift Solutions at a level that will not adversely affect Zift PRM performance.

This article explains the API Call Limits and how to access the Zift Solutions REST API documentation online.

API Call Limits

To prevent performance degradation, Zift Solutions controls the number of calls that can be made across each API instance. For staging, these limits are:

• Max Requests: The maximum number of requests by the API over a 24 hour period. The default setting is 1000.
• Query Batch Size: The maximum number of records that will be returned to any API query. The allowed range is 1-2000. The default value is 1000.

The settings for the production server will vary according to the Zift PRM version you have purchased.

How to Access the Zift PRM API Online Documentation

The Zift Solutions REST API is self-documenting. You will be able to access documents from two tabs: API Configuration and API Documentation. Use these steps to access this information.

1. Navigate to https://yourcompanyname.ziftprm.com/api/v1?docs.
2. You will be able to see the API Summary page that includes a tab for API Configuration and API Documentation.

Note: You cannot access the API docs from the Portal URL.