Skip to main content

Integration architecture

Ramon has three separate surfaces:

Participant browser ── public tracking key ──> Ramon Embed ──> event collector
Platform server ───── organization integration key ──────────> Integration API
Platform administrator ──────────────────────────────────────> Ramon Admin

The browser receives a public tracking key (trackingKey) and never receives the private integration key. The platform server uses its private Bearer key only for the /integrations/v1 API. Ramon Admin creates, displays, and revokes those keys.

Provisioning returns the tracking key, API collector URL, and embed script URL. The platform then renders the embed on its survey pages. Use the same Ramon session reference in the browser and your response mapping when you need a direct lookup.

Lifecycle​

  1. Create an integration key in Ramon Admin.
  2. Provision the external survey through the Integration API.
  3. Render the browser embed using the returned tracking key.
  4. Associate the Ramon session reference with your platform response.
  5. Start scoring explicitly when your workflow permits it.
  6. Poll the scoring run and look up session results.
  7. Request deletion when the source response is deleted.