Getting started
ConnectPlane API v1 exposes approved commerce, checkout, order, and lead workflows through the API Gateway. Use the production or staging server that matches your integration environment:
- Production:
https://api.connectplane.com - Staging:
https://api.staging.connectplane.com
Create a scoped key
Section titled “Create a scoped key”An account administrator creates an API key in the authenticated ConnectPlane account portal. Each key belongs to one tenant and carries an explicit set of permissions.
Keep the key in a runtime secret store and expose it to the application through an environment variable or secret-store reference.
Make a request
Section titled “Make a request”curl https://api.connectplane.com/api/v1/commerce/orders \ -H "X-API-Key: ${CONNECTPLANE_API_KEY}"A successful response is JSON. Errors use
application/problem+json and include a stable title and request ID.
Continue
Section titled “Continue”- Read Authentication before storing or rotating keys.
- Review Versioning before binding to response fields.
- Implement Errors and retries before enabling production traffic.
- Browse the read-only API reference for operations and schemas.