Every term these docs use, defined once. Each term has one name on every page.
| Term | Meaning |
|---|---|
| Platform | Your product: the software your users work in. A partner key identifies it |
| Partner key | The secret that identifies your platform. Sent as X-Flume-Partner-Key. See Authentication and keys |
| User | One person on your platform. You name them with external_ref |
| Verify | What a user does once to prove their email: they type a 6-digit code. See Users and verification |
| User access token | The secret that lets you call the API for one verified user. Sent as X-Flume-User-Token |
| Flume account | The user's own account at Flume. Flume opens or links one when the user verifies |
| Flume app | Flume's own website, where a user sees their searches, quotes and projects |
| Project | A job the user is working on. You name it with project.external_ref. Flume files searches and quotes under it |
| Item | The thing the user wants a product for, such as one line of a schedule. You name it with item.external_id |
| Product | One tile or vinyl floor in Flume's catalog. Flume names it with sku_uuid |
| Search | One photo search. Flume names it with search_session_uuid |
| Strong match | A search result that meets every filter and looks closest to the photo |
| Instant quote | The delivered price of one product for a quantity and a US ZIP code |
| Shipping option | One way a product ships: from a US warehouse, or from the factory abroad. A quote has one price per option |
| Save payload | The JSON object Flume hands you when a user saves a product. See Save payload |
| Sales request | A request for Flume's sales team, for what Flume cannot search or price instantly |
| Deep link | A one-time link that opens the Flume app with the user signed in. See Deep links |
| Iframe | The page Flume hosts and you frame. It runs the whole find, price and save flow |
| Your page | The page on your platform that frames the iframe |
| Iframe session | One user working on one item in the iframe. Flume names it with session_uuid |
| Launch code | The single-use code inside iframe_url. It lets the iframe start once |
| Connect code | The single-use code your page receives after a user verifies in the iframe. Your backend exchanges it for the user access token |
| Ready timer | The 15 second timer your page runs while it waits for the iframe to load |
| Sandbox | The environment for building. See Environments |
| Live | The environment for real users. Access is by request |