- Follow Step 1 of this guide to create your Standalone API Key, then
- Follow the How to Make an API Call Using a Standalone API Key (Postman) article to configure Postman and make your first API call.
Before You Start
You must have:- Access to the Pleo Web App in Staging or Production
- Admin or Bookkeeper permissions
What You’ll Have Built
By the end of this workflow:- You have generated a Standalone API Key
- You understand environment and permission scoping
- You have successfully authenticated against the Pleo API
Workflow Steps
1. Generate Your Standalone API Key
Purpose: Create an API Key in the Pleo Web App for your chosen environment. Input: No inputs. See Before You Start section. Output: A scoped API Key usable for authenticating API requests. Integration Design / Why It Matters:- Standalone API Keys authenticate API requests and are scoped by environment, company, and permitted API scopes.
- Always store API Keys securely after creation. Never expose them publicly or embed them in client-side code.
How to Generate an API Key
Generate a Standalone API Key from the Pleo Web App.
2. Authenticate Your First API Request
Purpose: Confirm API connectivity using your Standalone API Key. Input:- API Key (authentication header)
company_idassociated with your Pleo company
Make an API Call Using an API Key
Authenticate your first request.
Result
After completing this guide:- You have a valid Standalone API Key
- You have confirmed API connectivity
- You have a working authenticated setup
What Comes Next?
- Test additional Pleo API endpoints using Standalone API Keys
- Move to OAuth 2.0 if building multi-customer integrations:
Related Reading
- Integration Design for Standalone API Keys
- User Experience Guidelines for Standalone API Keys
- Security and Credential Management for Standalone API Keys