Articles in this section

Set up a connection to Pigment

Tanisha Ray
Updated

Pigment is a financial planning and analysis tool that enables you to identify opportunities, build accurate plans, and forecast your business in real-time.

Set up a connection

After you start the connection, configure it in the Create connection panel and complete all of the required * authentication settings:

Setting

Instructions

Name your connection * 

Enter a clear and distinguishable name.

Throughout integrator.io imports and exports, you will have the option to choose this new connection. A unique identifier will prove helpful later when selecting it from a list of the connections in your account.

API type * 

Choose your Pigment account API type:

  • Export: Get metric, list, and table block export details

  • Import: Get status and data to block import details

  • Audit logs: Get monitoring and track audit details

  • SCIM: Get user activity data details

API type: Export 

View ID * 

Enter your Pigment export view ID.  For detailed information on how to retrieve the view ID, seeExport data from Pigment with APIs.

API key * 

Enter your Pigment export API key.

Multiple layers of protection, including AES 256 encryption, are in place to keep your API key safe. When editing this connection, you must re-enter this value each time; it is stored only when the connection is saved and never displayed as text.

How to retrieve the API key

API type: Import 

Import ID * 

Enter your Pigment import ID. For detailed information on how to retrieve the import ID, seeCreate access signature.

API key * 

Enter your Pigment import API key.

Multiple layers of protection, including AES 256 encryption, are in place to keep your API key safe. When editing this connection, you must re-enter this value each time; it is stored only when the connection is saved and never displayed as text.

 How to retrieve the API key

API type: Audit logs 

API key * 

Enter your Pigment audit logs API key.

Multiple layers of protection, including AES 256 encryption, are in place to keep your API key safe. When editing this connection, you must re-enter this value each time; it is stored only when the connection is saved and never displayed as text.

How to retrieve the API key

API type: SCIM 

API key * 

Enter your Pigment SCIM API key.

Multiple layers of protection, including AES 256 encryption, are in place to keep your API key safe. When editing this connection, you must re-enter this value each time; it is stored only when the connection is saved and never displayed as text.

How to retrieve the API key

How to retrieve the export API key

  1. Sign in to your Pigment account. 

  2. Navigate to Workspace settings > API keys.

  3. Click + Create API key.

  4. Enter a Name and choose an Expiration date.

  5. Select Export as Key type.

  6. Click Generate.

  7. Copy the API key. For more information, see API keys.

How to retrieve the import API key

  1. Sign in to your Pigment account. 

  2. Navigate to Workspace settings > API keys.

  3. Click + Create API key.

  4. Enter a Name and choose an Expiration date.

  5. Select Import as Key type.

  6. Click Generate.

  7. Copy the API key. For more information, see API keys.

How to retrieve the audit logs API key

  1. Sign in to your Pigment account. 

  2. Navigate to Workspace settings > API keys.

  3. Click + Create API key.

  4. Enter a Name and choose an Expiration date.

  5. Select Audit logs as Key type.

  6. Click Generate.

  7. Copy the API key. For more information, see API keys.

How to retrieve the SCIM API key

  1. Sign in to your Bloomreach account. 

  2. Navigate to Settings > Members > Identity and provisioning settings.

  3. Make sure the Single sign-on is enabled.

  4. Toggle on the SCIM provisioning.

  5. Click + Add token.

  6. Choose an Expiration date.

  7. Copy the API token. For more information, see Generate an API token.

Additional references