Pandium API
Introduction
Welcome to the Pandium API! Our API enables your team flexibility in managing your integrations hosted on Pandium. The Pandium API uses standard REST conventions and standard HTTP methods and response codes for a simple and intuitive workflow.
With the Pandium API, native Pandium resources (integrations, tenants, and runs) are accessible via a generated API key, and allow for triggering runs externally - no login to the Pandium Integration Hub needed. As we expand the Pandium API, check back for additional functionality, or stay up to date on our product updates page.
Base URL
Below you'll find the base URLs used when working with the Pandium API:
For using the Pandium API with a Production Pandium account: http://api.pandium.io/
For using the Pandium API with a Sandbox Pandium account: http://api.sandbox.pandium.com/
Authentication
To generate an API Key, navigate to the 'Settings' sidebar resource in the Pandium Integration Hub, then head over to the "API Access" tab. Here, you can give your key a name and generate it.
API Keys are only viewable at creation, so store and keep your key(s) secure.
To use the generated key, attach it to your request under an x-api-key
header, like so:
Integrations
In Pandium, the integration object can be thought of as the primary record for any application on the platform. This record holds the necessary components to run syncs between systems, and the content that a given application utilizes for marketplace views.
Integration IDs can be found in the Integration Hub on the Integration Detail page.
Get Many Integrations
Get all your integrations on Pandium.
Successful Response
An enumeration.
An enumeration.
Get One Integration
Get a single integration by its ID.
Unique identifier for an integration
Successful Response
An enumeration.
An enumeration.
Get Integration Releases
Get all releases for a specific integration.
Unique identifier for an integration
Successful Response
Get One Integration Release
Get a single release for a specific integration.
Unique identifier for an integration
Unique identifier for a release
Successful Response
Get Default Integration Release
Get the default release for an integration
Unique identifier for an integration
Successful Response
Get Latest Release
Get the latest release for an Integration
Unique identifier for an id
Successful Response
Sync By Integration Id
Request a sync for an existing tenant based on an integration ID and a user name. For this to work, the user must have installed the integration via the Pandium In-App Marketplace, which creates a tenant associated with that user's username. To sync a tenant created in the Pandium Integration Hub, use the sync by tenant id endpoint.
Unique identifier for an integration
fields determined by the integration
Successful Response
Tenants
In Pandium, a tenant is a single instance of an integration, associated with a single set of user credentials for each connected system.
Whenever a user installs an integration, a tenant is created within Pandium and is automatically given a tenant ID, which is viewable in the Integration Hub directly on the Tenant Detail page.
Get Many Tenants
Get all your tenants on Pandium.
Successful Response
An enumeration.
Sync By Tenant Id
Request a sync when the tenant id is known.
Unique identifier for a tenant
fields determined by the integration
Successful Response
Patch Tenant
Update a tenant's configs, user_schedule, or paused status. Configs are validated against the tenant's current integration release and any dynamic configs. User_schedule is randomized to create the tenant's schedule.
Unique identifier for a tenant
must be a valid cron string
Successful Response
An enumeration.
Delete Tenant
Archive a tenant.
Unique identifier for a tenant
Successful Response
Get Tenant Release
Get the tenant's current integration release. Available dynamic configs will be populated.
unique identifier for a tenant
Successful Response
Proxy Endpoints
An endpoint that allows a user to make a call to an external API (REST, SOAP, or XML) on behalf of a tenant.
Proxy Connector Call Rest
Proxy a synchronous connector call.
Unique identifier for a tenant
Name of the tenant's authenticated connector
Headers needed for the proxied request
"GET"
Query params needed for the proxied request
Endpoint for the proxied request
"www.example.com/users"
Body of the proxied request
Successful Response
Proxy Connector Call Soap
Proxy a synchronous connector call to a SOAP endpoint.
Unique identifier for a tenant
Name of the tenant's authenticated connector
Headers needed for the proxied request
"GET"
Query params needed for the proxied request
Endpoint for the proxied request
"www.example.com/users"
XML data for the proxied request. Authentication will be handled by Pandium and doesn't need to be included in the request.
"<Envelope><Body>...</Body></Envelope>"
Successful Response
Proxy Connector Call Xml
Proxy a synchronous connector call to an XML endpoint.
Unique identifier for a tenant
Name of the tenant's authenticated connector
Headers needed for the proxied request
"GET"
Query params needed for the proxied request
Endpoint for the proxied request
"www.example.com/users"
XML data for the proxied request. Authentication will be handled by Pandium and doesn't need to be included in the request.
"<Envelope><Body>...</Body></Envelope>"
Successful Response
Runs
A run is a specific record of a sync: a single execution of integration code using the credentials provided by a tenant of that integration, at a specific point in time. The runs endpoints are by nature read-only.
More run information can be seen by viewing the logging information from within the Integration Hub.
Get Run Status From Trigger
Returns status information for a run associated with the provided trigger id, if that run exists. Triggers are are debounced, so run status information may not be immediately available. If no status information is yet available, this endpoint will return a 404.
Returned from Pandium after a sync request in the response payload
Successful Response
"in progress"
Last updated