Skip to main content

Authentication

Overview​

API authentication is the cornerstone of secure API interactions. Our system requires proper authentication through an API key & secret to ensure only authorized clients can publish messages & subscribe to topics.

Key Authentication Principles:

  • API keys and secrets are generated through the Developer Console for secure access
  • Zero server storage – Your API Key & secret are never stored on our servers for maximum security
  • Stateless authentication – Each authentication request is independently verified without session dependency

Once successfully authenticated, your client gains full access to send and receive messages across our network. Authentication acts as your digital passport, validating your identity before granting access to protected resources.

Generate API Keys​

Quick Start
  1. Create a project → Go to Settings → Generate API Keys → Download
  2. Use the keys in your SDK initialization (see code examples below)
  3. Keep your keys safe, we do not store them anywhere

Step-by-Step Key Generation​

Follow these detailed steps to create and securely download your API credentials:

  1. Create a Project

    • From the side menu, click on + Add Project
    • Enter a name for your project Alt Text
    • Click on "Create"

  2. Navigate to Project Settings

    • Open your project by clicking on the project name in the side menu
    • Go to the Settings page

  3. Generate API Keys

    • Click on Generate API Keys
    • Enter the confirmation text in the dialog Alt Text
    • Click Generate to proceed

  4. Secure Download

    • Your API Key & Secret are now ready to use
    • Critical: Click Download immediately to save your credentials Alt Text
    • The download contains both your API key and secret
    • You cannot retrieve your secret again – store it securely

Initializing SDK with API Key & Secret​

info

The API keys in the code below are the keys you loaded during the interactive demo

// Select a platform to see code

Key Limitations and Restrictions​

  • Single Active Key: Only one API key pair is permitted per account
  • Key Invalidation: Generating new keys immediately invalidates previous keys
  • Network Disruption: All clients using old keys are disconnected when new keys are generated
  • No Key Recovery: Lost secrets cannot be retrieved - you must generate new keys


Need Help?

Join our Discord server, post your concern & someone from our team will help you out ✌️