Skip to main content
This article explains what customers see inside Pleo when installing an integration that uses Integrated API Keys. It helps integration developers understand:
  • Where the API Key originates
  • What permissions users approve
  • When users are redirected to your product
  • When your integration should expect the API Key

​
Overview

Integrated API Keys are generated automatically during installation of a supported integration. Customers do not manually create these keys. Instead, Pleo creates a customer-specific API Key after the user grants permissions to the integration.

​
High-Level Installation Flow

  1. Customer selects an integration in Pleo
  2. Pleo displays requested permissions
  3. Customer approves access
  4. Pleo generates an Integrated API Key
  5. Customer copies the API Key
  6. Customer is redirected to the integration
  7. Customer provides the API Key inside the integration
  8. Integration validates the connection
  9. Successful activation redirects the user back to Pleo

​
Step-by-Step Customer Experience

​
1. Customer initiates installation

In the Pleo Web App:
  • Navigate to Settings
  • Select Accounting
  • Choose the integration (example: Microsoft Dynamics 365 Finance)
Pleo install modal showing permissions requested by Microsoft Dynamics 365 Finance, with Cancel and Allow buttons.

​
2. Permission approval

Pleo displays the permissions required by the integration. The user must explicitly approve access. After clicking Allow, installation continues.

​
3. Integrated API Key generation

Pleo generates a customer-specific Integrated API Key. The user is shown:
  • The API Key
  • A copy-to-clipboard button
  • Installation instructions
Typical instructions:
  1. Copy the API Key above
  2. Click the button below to open the integration
  3. Log in to the integration
  4. Provide the copied API Key
  5. Complete connection setup
Pleo install modal showing a generated Integrated API Key with a copy button, installation instructions, and a Go to Microsoft Dynamics 365 Finance button.

​
4. Redirect to integration

The user clicks: Go to [Integration Name] They are redirected to your product to complete setup.

​
5. Integration activation

Inside your integration:
  • User pastes the API Key
  • Integration validates connectivity
  • Successful validation completes installation
  • User may be redirected back to Pleo

​
Developer Expectations

Your integration should assume:
  • The API Key is copied manually by the customer
  • The user may switch tabs during installation
  • Validation must occur immediately after entry
  • Installation is not complete until validation succeeds
See:

​
Integrated API Keys vs Standalone API Keys

AspectIntegrated API KeysStandalone API Keys
How access beginsCustomer installs integration from PleoCustomer creates API Key in Settings
Key creation momentGenerated during installation flowGenerated manually in API Keys settings
Permission configurationPredefined by Pleo integration setupSelected by customer when creating the key
Customer approvalGranted by approving installation permissionsGranted when selecting scopes during key creation
Relationship to integrationKey is tied to a specific integration installKey can be used by any compatible integration
Key ownership modelOne key per customer installationOne or more keys per company environment
Typical usageApproved accounting / ERP integrationsCustom or developer-built integrations