Overview
internal-docs-marker: modulate-apiThe Modulate API is the internal, Google-authenticated surface of the same merchant, pricing, transaction, statement, residual, and capital contracts that partners consume publicly. Flute dashboard is the approved consumer. The API is not a general-purpose public product.
Docs access is separate from API authorization and is configured in the Scalar dashboard. The intended audience for internal-only material is verified @flute.com users. Every data request still needs a short-lived Google identity token for a registered principal.
What you can build
- Server-side Flute dashboard reads that resolve a merchant from a local record the signed-in user is allowed to see
- Operator troubleshooting against UAT with impersonation, Postman, or the built-in API client
- Read-only monitor correlation using the request id returned on every response
The browser never receives a Google token and never calls the API directly.
API basics
| Property | Value |
|---|---|
| UAT base URL | https://uat.modulate-api.es.flute.com |
| Protocol | HTTPS only |
| Format | JSON request and response bodies |
| Authentication | Authorization: Bearer <Google ID token> only |
| Versioning | URL-based (/api/partner/...) |
Production exists as a data plane with Cloud Run invoker IAM. It is absent from the API Reference server list. Do not point the built-in API client, Postman collections checked into these docs, or local preview at production.
Data sources and planned performance work
See Data sources and performance roadmap for current warehouse/AlloyDB sources and planned hot or hot/cold reads. These are planned optimizations, subject to coverage and query-safety validation.
Support
The Enterprise Systems Team owns this surface. See Support for escalation. After the first mention, this guide says "the API".
