Integration profile
ERP integration · GENERIC API
Provider REST API integration with an explicit request/response mapping. A provider-specific API schema or approved adapter is required; selecting a product does not configure its API.
Demo baseline · November 13, 2026Prerequisites
- Protected HTTPS provider API
- Secret Manager credential
- Provider-approved purchase-order payload and response reference mapping
Configuration steps
- Configure a protected read-only test path
- Map purchase-order fields to the provider schema
- Run the real authenticated API test
- Submit an approved test order and reconcile its returned provider reference
Provider fields
| Field | Type | Requirement and options |
|---|---|---|
Authentication schemeauthScheme | select | Requiredbearer_token, api_key, basic, oauth2_client_credentials |
Protected read-only API test pathtestPath | text | Required |
Purchase-order API pathsubmissionPath | text | Required |
Provider reference response pathreferencePath | text | Required Dot-separated JSON path, for example data.orderNumber. |
Read-only order lookupreconciliationPath | text | Optional Optional HTTPS same-origin GET path. Include {orderId} in the path or query; it is replaced with the original idempotency key. |
Response request keyreconciliationKeyPath | text | Optional Dot-separated path to the original request ID in the response. It must match exactly to confirm the delivery. |
Provider request JSON mappingrequestTemplate | textarea | Required JSON values can reference {{order.number}}, {{order.quantity}}, {{order.unitCost}}, {{order.currency}}, {{model.modelNumber}} and other saved order/model fields. |
API-key header nameapiKeyHeader | text | Optional |
OAuth token URLtokenUrl | url | Optional |
OAuth scopesscope | text | Optional |
Verify and troubleshoot
Test with the narrowest supported non-production scope. Confirm that the connection test reaches the expected provider and that the preview or receipt matches the intended scope. Check identity, credential references, network access and provider permissions before retrying. Record the failure stage and redact sensitive payloads when escalating.