API - PIM

How to set up API Keys, plan limits, and documentation

Plytix offers an API for the PIM which enables other applications to create, edit and extract information directly in Plytix. This is essential in case you need to integrate an ERP system or any other service directly with Plytix.

Documentation

In order to learn how the API works in detail, jump over to http://apidocs.plytix.com to access the technical documentation.

Plan Limits

Plytix has two plan types with distinct rate limits for the API. All rate limits are applied based on API credentials known as keys. These limits are enforced on all the resources available in the API. 

FREE

Each API key in the Free plan is allowed 20 requests every 10 seconds, capped at 2000 requests per hour. 

PRO

Each API key in the PRO plans are allowed 50 requests every 10 seconds, capped at 5000 requests per hour.

Create API Keys

API Keys are required before you can create a successful integration with the Plytix API. 

The API credentials functions as a set of keys to all the data in your account, so only share the API credentials with trusted contacts and services.

To create API credentials, you must have Admin rights. 

 

How to generate an API Key

  1. Navigate to the Accounts Administration section of Plytix. 
  2. Locate the API tab

    API-Key
  3. Click CREATE API KEY
  4. Give your Key a name. We recommend identifying the integration or party who will be using the Key for better organization. 
  5. Set the role of the API key, which will determine rights of access.
  6. Click CREATE API KEY to save

 

To reveal the API Password, hover near it and click the EYE icon. 

Screenshot 2020-02-25 at 10.59.04 You can also edit and delete API keys using the icons next to the assigned role. 

 

API Roles

API Roles are the same as System Roles and Team Roles, and you can set them accordingly.