Skip to main content

Jasper PIM Connections and Settings

Connect Jasper PIM with iPaaS.com to sync product-related data such as product options, variants, and inventory.

Jasper PIM Connections and Settings

The Jasper PIM integration connects iPaaS.com to a Jasper PIM tenant using API Key authentication with a Bearer token. All API requests are sent to the subscriber's Jasper PIM tenant host and authenticated using a Jasper PIM-issued API key sent in the Authorization: Bearer <token> header on every call.

The integration currently supports the From iPaaS direction only — outbound transfers from iPaaS.com to Jasper PIM. There is no inbound (To iPaaS) pull path or webhook receiver from Jasper PIM into iPaaS.com. Subscribers who need data to flow from Jasper PIM back into iPaaS.com today should contact iPaaS.com Support to discuss alternative patterns.

Subscription Settings

The following subscription settings are configured on the iPaaS.com Subscription Settings page during installation and are available for ongoing reference and updates.

For step-by-step first-time setup instructions, including how to obtain the API Key from Jasper PIM, see the Jasper PIM Installation Instructions.

Setting Name

Required

Purpose

Default Value

Name

Yes

A unique identifier for the subscription within the company. Conventional format: [Product Name] – [Environment/Purpose], for example Jasper PIM – Release.

None

Versions

No

The Jasper PIM connector version. iPaaS.com selects the latest compatible version by default; subscribers can pin an older version when needed for compatibility.

Latest

Create Default Mappings

No

When checked, iPaaS.com auto-creates the standard mapping collections (Product, Product Inventory, Product Category, Product Option, Product Option Value, Product Variant, Product Variant Option, Product Variant Inventory, and the two standalone Updates collections) using the canonical Jasper PIM template. Uncheck only if the subscriber intends to author every mapping collection manually.

Checked

API URL

Yes

The Jasper PIM tenant API endpoint URL. Construct by taking the host of the Jasper PIM dashboard URL and appending /api/v1. Older tenants use the *.oci-1.jasperpim.com host pattern; newer tenants use the *.pim.jasperpim.com host pattern.

None

API Key

Yes

The Bearer token generated in Jasper PIM under Settings > API Key. Sent as the Authorization: Bearer <token> header on every API call.

None

API Throttle Limit

Yes

Maximum number of API calls per throttle window sent to Jasper PIM.

500

API Throttle Seconds

Yes

Duration of each throttle window in seconds.

60

Concurrent Connections

Yes

Maximum number of simultaneous API connections to Jasper PIM. Range: 1–10.

10

Concurrent Batch Executions

Yes

Maximum number of batch operations that can run simultaneously for this subscription. Range: 1–10.

10

For a visual reference of these fields on the iPaaS.com Subscription Settings page:

iPaaS.com Subscription Settings page for the Jasper PIM integration, showing the Name, Versions, Create Default Mappings, API Key, and API URL fields

NOTE: Jasper PIM does not publish a numeric rate-limit or per-period quota in its public API documentation; capacity is environment-dependent. The integration does not implement automatic rescheduling for rate-limit responses from Jasper PIM. To avoid timeouts and performance drops, subscribers or their MiSP should follow the published Jasper PIM operating guidance: stagger mass syncs, imports, and updates rather than running them concurrently; check the Jasper PIM Jobs Table before launching a batch action; and avoid running multiple intensive processes simultaneously. (Source: Jasper PIM "General Do's & Don'ts" Knowledge Base article.) See the Throttling section below for tuning guidance.

Authentication Methods

API Key (Bearer Token) — the only supported authentication method

How it works:

  1. The subscriber generates an API key in their Jasper PIM tenant. Navigate to Settings > API Key in the Jasper PIM side menu:

    Jasper PIM side navigation menu with the API Keys item under Settings highlighted

    On the API Keys page, click Create Token in the top-right:

    Jasper PIM API Keys page header with the Create Token button highlighted

    Assign the user account and name, then click Create. Jasper PIM displays the My API Key dialog with the generated token and a warning that the key can only be viewed once. Copy the token immediately and store it securely:

    Jasper PIM My API Key dialog showing the generated bearer token and a warning that the key can only be viewed once
  2. The subscriber pastes the key into the API Key Subscription Setting on the iPaaS.com Subscription Settings page, along with the API URL for the tenant, then saves:

    iPaaS.com Subscription Settings page with the API Key and API URL fields highlighted
  3. iPaaS.com stores the key in encrypted form and sends it as the Authorization: Bearer <token> header on every API call to the tenant's API URL.

Token lifecycle:

  • API Key: Long-lived. Issued by Jasper PIM and remains valid until the subscriber explicitly revokes it in Jasper PIM, deletes the issuing user account, or rotates to a new key. iPaaS.com does not auto-refresh keys — re-authentication only happens when the subscriber updates the API Key Subscription Setting.

Request headers sent on every API call:

Header

Value

Content-Type

application/json

Accept

application/json

Authorization

Bearer <API Key from Subscription Settings>

Error conditions:

  • If the API Key is missing, expired, or revoked in Jasper PIM, the integration fails subsequent API calls with a Jasper PIM authentication error. The failure surfaces in iPaaS.com under Dashboard / Integration Monitoring / Error Logs. To resolve, generate a fresh API key in Jasper PIM and update the API Key Subscription Setting.

Credential Rotation

Rotating the API Key

  1. In Jasper PIM, navigate to Settings > API Key.

  2. Click Create Token, assign a user account and name, and click Create. Copy the new key immediately — Jasper PIM does not redisplay it after the dialog is closed.

  3. In iPaaS.com, update the API Key Subscription Setting with the new key value and click Apply.

  4. Once the new key has been verified end-to-end with a manual sync (see Connection Validation below), return to Jasper PIM and revoke or delete the previous key to keep the credential surface area minimal.

NOTE: Use a dedicated Jasper PIM account for API access rather than a personal user account so that key rotation, password changes, or user deactivation on the personal account do not unexpectedly break the integration.

Connection Validation

To verify the connection is working after installation or credential rotation:

  1. Initiate a Manual Sync of any known iPaaS.com Product, Product Category, or Product Inventory record from the iPaaS.com Manual Sync page.

  2. Check the integration logs in iPaaS.com under Dashboard / Integration Monitoring / Error Logs for the resulting API call entries. A successful sync produces no error-log rows for the manual transfer; an authentication or connectivity failure produces an explicit error row identifying the failed endpoint and response.

  3. Optionally, confirm in Jasper PIM that the created or updated record reflects the values sent from iPaaS.com.

Initialization Support

Currently, initialization (bulk data import on first connect) is not supported for Jasper PIM in iPaaS.com. All data synchronization and mappings must be configured manually during the integration process.

Subscribers who need to push an entire product catalog into Jasper PIM in a single operation should use the canonical workaround documented in bulk sync using Postman.

Throttling

The integration uses configurable throttle settings to control the rate and volume of API calls to the Jasper PIM tenant. These settings are pre-populated with recommended defaults during installation and can be adjusted on the Subscription Settings page.

  • API Throttle Limit / API Throttle Seconds: Controls outbound (from iPaaS.com to Jasper PIM) call rate. Default: 500 calls per 60-second window.

  • Concurrent Connections: Limits simultaneous API connections to Jasper PIM. Default: 10 (range: 1–10).

  • Concurrent Batch Executions: Limits simultaneous batch operations. Default: 10 (range: 1–10).

The integration does not currently expose API Throttle Limit (to iPaaS.com) or API Throttle Seconds (to iPaaS.com) settings because the Jasper PIM connector operates in the From iPaaS direction only.

NOTE: Jasper PIM does not publish a numeric rate-limit or per-period quota for its API. Capacity is environment-dependent. If subscribers see Jasper PIM timeouts or performance degradation during heavy transfers, reduce the throttle limit and concurrency settings, and stagger mass operations per the Jasper PIM "General Do's & Don'ts" guidance.

For more detail on throttle configuration, see Subscription Configuration – Edit.

Related Documents

Did this answer your question?