Skip to main content

Introduction

Halosight uses token-based authentication for all embeddable components.
To enable this, Halosight provisions an API key for your integration.

Your backend will exchange this API key for short-lived access tokens, which are then passed to your client.

Authentication Flow Diagram

Authentication flow diagram

API Key​

  • Provided by Halosight once integration is ready.
  • Must be stored securely on your server.
  • Never include the API key in client-side code (doing so exposes your credentials).